; Clarify recently added documentation
authorEli Zaretskii <eliz@gnu.org>
Sat, 18 Sep 2021 18:04:07 +0000 (21:04 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 18 Sep 2021 18:04:07 +0000 (21:04 +0300)
* etc/NEWS:
* doc/emacs/help.texi (Name Help): Clarify documentation of
'help-enable-symbol-autoload'.

doc/emacs/help.texi
etc/NEWS

index f7fcd207ee15bc7657ac022d8fb3f894155a4759..9f6009b321e75e74f550a5b84c1c301fc5a964f7 100644 (file)
@@ -279,11 +279,13 @@ name is defined as a Lisp function.  Type @kbd{C-g} to cancel the
 documentation.
 
 @vindex help-enable-symbol-autoload
-  If you request help for an autoloaded function that doesn't have a
-doc string, the @file{*Help*} buffer won't have any doc string to
-display.  If @code{help-enable-symbol-autoload} is non-@code{nil},
-Emacs will try to load the file the function is defined in to see
-whether there's a doc string there.
+  If you request help for an autoloaded function whose @code{autoload}
+form (@pxref{Autoload,,, elisp, The Emacs Lisp Reference Manual})
+doesn't provide a doc string, the @file{*Help*} buffer won't have any
+doc string to display.  In that case, if
+@code{help-enable-symbol-autoload} is non-@code{nil}, Emacs will try
+to load the file in which the function is defined to see whether
+there's a doc string there.
 
 @findex shortdoc-display-group
   You can get an overview of functions relevant for a particular topic
index a0da78a1f613fc373b38bf9aadcc44cccf657f10..5c78189738f2158657d9bff7ff04db11c3bf427f 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -586,10 +586,12 @@ be assumed to be a propertized string.
 Note that the new face will also be used in tooltips.  When using the
 GTK toolkit, this is only true if 'x-gtk-use-system-tooltips' is t.
 
++++
 *** New user option 'help-enable-symbol-autoload'.
-If non-nil, displaying help for an autoloaded function that has no
-documentation string will try to load the file it's from.  This will
-give more extensive help for these functions.
+If non-nil, displaying help for an autoloaded function whose
+'autoload' form provides no documentation string will try to load the
+file it's from.  This will give more extensive help for such
+functions.
 
 ---
 *** The 'help-for-help' ('C-h C-h') screen has been redesigned.