; Improve doc strings of several Help-related user options

* lisp/help-fns.el (help-enable-completion-autoload)
(help-enable-symbol-autoload):
* lisp/help.el (help-enable-autoload): Doc fixes.
This commit is contained in:
Eli Zaretskii 2026-05-06 14:19:50 +03:00
parent 61e9dfe5f7
commit d962c83aa3
2 changed files with 6 additions and 3 deletions

View file

@ -127,7 +127,7 @@ current help buffer.")
(defcustom help-enable-completion-autoload t
"Whether completion for Help commands can perform autoloading.
If non-nil, whenever invoking completion for `describe-function'
or `describe-variable' load files that might contain definitions
or `describe-variable', load files that might contain definitions
with the current prefix. The files are chosen according to
`definition-prefixes'."
:type 'boolean
@ -148,7 +148,10 @@ edited even if this option is enabled."
:version "29.1")
(defcustom help-enable-symbol-autoload nil
"Perform autoload if docs are missing from autoload objects."
"Perform autoload if doc string is missing from an autoloaded object.
If non-nil, if an autoloaded object lacks a doc string, Help commands
will load the file where the object is defined, in order to be able
to show its documentation."
:type 'boolean
:group 'help
:version "28.1")

View file

@ -2110,7 +2110,7 @@ Also see `help-window-select'."
'help-enable-autoload "27.1")
(defcustom help-enable-autoload t
"Whether Help commands can perform autoloading.
"Whether Help commands can perform autoloading in order to show key bindings.
If non-nil, whenever \\[describe-function] is called for an
autoloaded function whose docstring contains any key substitution
construct (see `substitute-command-keys'), the library is loaded,