procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Clarify recently added documentation

Browse source 
* etc/NEWS:
* doc/emacs/help.texi (Name Help): Clarify documentation of
'help-enable-symbol-autoload'.
This commit is contained in:
Eli Zaretskii 2021-09-18 21:04:07 +03:00
parent c53aff5de7
commit acba74a395
2 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/emacs/help.texi
View 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

8
etc/NEWS
View file

@ -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.