From 510347977e4dd86ccf5ce74a78633902a6e2766b Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Fri, 9 May 2025 01:14:16 -0400 Subject: [PATCH] docs(lib): revise various docstrings --- lisp/doom-lib.el | 8 ++++---- lisp/lib/profiles.el | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lisp/doom-lib.el b/lisp/doom-lib.el index dd699f52e..eeee22c97 100644 --- a/lisp/doom-lib.el +++ b/lisp/doom-lib.el @@ -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." diff --git a/lisp/lib/profiles.el b/lisp/lib/profiles.el index d59ea2755..08903a716 100644 --- a/lisp/lib/profiles.el +++ b/lisp/lib/profiles.el @@ -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