awesome-emacs/doomemacs
1
0
Fork 0
mirror of https://github.com/doomemacs/doomemacs synced 2025-08-01 12:17:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(lib): revise various docstrings

Browse Source
This commit is contained in:
Henrik Lissner
2025-05-09 01:14:16 -04:00
parent 5477ba4c16
commit 510347977e
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lisp/doom-lib.el
View File

@ -1072,7 +1072,7 @@ All valid contexts:
(put 'doom-context 'risky-local-variable t) (put 'doom-context 'risky-local-variable t)
(defun doom-context-p (contexts) (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." See `doom-context' for possible values for CONTEXT."
(declare (side-effect-free t)) (declare (side-effect-free t))
@ -1084,12 +1084,12 @@ See `doom-context' for possible values for CONTEXT."
(throw 'result nil)))))) (throw 'result nil))))))
(defun doom-context-valid-p (context) (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)) (declare (pure t) (side-effect-free error-free))
(memq context (get 'doom-context 'valid))) (memq context (get 'doom-context 'valid)))
(defun doom-context-push (contexts) (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 Return list of successfully added contexts. Throws a `doom-context-error' if
CONTEXTS contains invalid contexts." CONTEXTS contains invalid contexts."
@ -1110,7 +1110,7 @@ CONTEXTS contains invalid contexts."
added))))) added)))))
(defun doom-context-pop (contexts) (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 Return list of removed contexts if successful. Throws `doom-context-error' if
one of CONTEXTS isn't active." one of CONTEXTS isn't active."

4
lisp/lib/profiles.el
View File

@ -50,13 +50,13 @@ Can be changed externally by setting $DOOMPROFILELOADFILE.")
Can be changed externally by setting $DOOMPROFILELOADFILE.") Can be changed externally by setting $DOOMPROFILELOADFILE.")
(defvar doom-profile-env-file-name "init.env.el" (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) (defvar doom-profile-init-dir-name (format "init.%d.d" emacs-major-version)
"The subdirectory of `doom-profile-dir'") "The subdirectory of `doom-profile-dir'")
(defvar doom-profile-rcfile ".doomprofile" (defvar doom-profile-rcfile ".doomprofile"
"TODO") "The filename for local user configuration of a Doom profile.")
;;; Profile storage variables ;;; Profile storage variables
(defvar doom-profile-generators (defvar doom-profile-generators