mirror of
https://github.com/doomemacs/doomemacs
synced 2025-08-01 12:17:25 -05:00
docs(lib): revise various docstrings
This commit is contained in:
@ -1072,7 +1072,7 @@ All valid contexts:
|
||||
(put 'doom-context 'risky-local-variable t)
|
||||
|
||||
(defun doom-context-p (contexts)
|
||||
"Return t if all CONTEXTS are active, nil otherwise.
|
||||
"Return non-nil if all CONTEXTS are active.
|
||||
|
||||
See `doom-context' for possible values for CONTEXT."
|
||||
(declare (side-effect-free t))
|
||||
@ -1084,12 +1084,12 @@ See `doom-context' for possible values for CONTEXT."
|
||||
(throw 'result nil))))))
|
||||
|
||||
(defun doom-context-valid-p (context)
|
||||
"Return non-nil if CONTEXT is a valid `doom-context'."
|
||||
"Return non-nil if CONTEXT (a symbol) is a valid `doom-context'."
|
||||
(declare (pure t) (side-effect-free error-free))
|
||||
(memq context (get 'doom-context 'valid)))
|
||||
|
||||
(defun doom-context-push (contexts)
|
||||
"Add CONTEXTS to `doom-context', if not present.
|
||||
"Add CONTEXTS (a symbol or list thereof) to `doom-context', if not present.
|
||||
|
||||
Return list of successfully added contexts. Throws a `doom-context-error' if
|
||||
CONTEXTS contains invalid contexts."
|
||||
@ -1110,7 +1110,7 @@ CONTEXTS contains invalid contexts."
|
||||
added)))))
|
||||
|
||||
(defun doom-context-pop (contexts)
|
||||
"Remove CONTEXTS from `doom-context'.
|
||||
"Remove CONTEXTS (a symbol or list thereof) from `doom-context'.
|
||||
|
||||
Return list of removed contexts if successful. Throws `doom-context-error' if
|
||||
one of CONTEXTS isn't active."
|
||||
|
@ -50,13 +50,13 @@ Can be changed externally by setting $DOOMPROFILELOADFILE.")
|
||||
Can be changed externally by setting $DOOMPROFILELOADFILE.")
|
||||
|
||||
(defvar doom-profile-env-file-name "init.env.el"
|
||||
"TODO")
|
||||
"The filename for a Doom profile's envvar file.")
|
||||
|
||||
(defvar doom-profile-init-dir-name (format "init.%d.d" emacs-major-version)
|
||||
"The subdirectory of `doom-profile-dir'")
|
||||
|
||||
(defvar doom-profile-rcfile ".doomprofile"
|
||||
"TODO")
|
||||
"The filename for local user configuration of a Doom profile.")
|
||||
|
||||
;;; Profile storage variables
|
||||
(defvar doom-profile-generators
|
||||
|
Reference in New Issue
Block a user