General revision of docstrings

This commit is contained in:
Henrik Lissner 2018-05-11 20:22:05 +02:00
parent 7630394210
commit 57f383ef76
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
5 changed files with 23 additions and 16 deletions

View file

@ -119,7 +119,7 @@ fundamental-mode) for performance sake."
sp-show-pair-delay 0
sp-max-pair-length 3)
;; disable smartparens in evil-mode's replace state (they conflict)
;; smartparens conflicts with evil-mode's replace state
(add-hook 'evil-replace-state-entry-hook #'turn-off-smartparens-mode)
(add-hook 'evil-replace-state-exit-hook #'turn-on-smartparens-mode)

View file

@ -232,8 +232,8 @@ Body forms can access the hook's arguments through the let-bound variable
;; I needed a way to reliably cross-configure modules without worrying about
;; whether they were enabled or not, so I wrote `set!'. If a setting doesn't
;; exist at runtime, the `set!' call is ignored (and omitted when
;; byte-compiled).
;; exist at runtime, the `set!' call is ignored and its arguments are left
;; unevaluated (and entirely omitted when byte-compiled).
(defvar doom-settings nil)
(defmacro def-setting! (keyword arglist &optional docstring &rest forms)
@ -255,7 +255,9 @@ Do not use this for configuring Doom core."
(defmacro set! (keyword &rest values)
"Set an option defined by `def-setting!'. Skip if doesn't exist. See
`doom/describe-setting' for a list of available settings."
`doom/describe-setting' for a list of available settings.
VALUES doesn't get evaluated if the KEYWORD setting doesn't exist."
(declare (indent defun))
(unless values
(error "Empty set! for %s" keyword))