summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefan Monnier <monnier@iro.umontreal.ca>2024-03-23 22:27:34 -0400
committerStefan Monnier <monnier@iro.umontreal.ca>2024-03-23 22:27:34 -0400
commit044558766a77b1c9b8a7e6d757ca65730a88b88d (patch)
treeaf64b2c309e588efc8f9b55e644dada96ed8d7d8 /doc
parentef859d8b1b285fd22b083955a0e878a74d72ff41 (diff)
downloademacs-044558766a77b1c9b8a7e6d757ca65730a88b88d.tar.gz
* doc/emacs/help.texi (Name Help): Mention buttons (bug#69935)
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/help.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi
index 05457a3f34f..d60310456ff 100644
--- a/doc/emacs/help.texi
+++ b/doc/emacs/help.texi
@@ -310,6 +310,13 @@ name is defined as a Lisp function. Type @kbd{C-g} to cancel the
@kbd{C-h f} command if you don't really want to view the
documentation.
+ The function's documentation displayed by @code{describe-function}
+includes more than just the documentation string and the signature of
+the function. It also shows auxiliary information such as its type, the
+file where it was defined, whether it has been declared obsolete, and
+yet further information is often reachable by clicking or typing
+@key{RET} on emphasized parts of the text.
+
@vindex help-enable-symbol-autoload
If you request help for an autoloaded function whose @code{autoload}
form (@pxref{Autoload,,, elisp, The Emacs Lisp Reference Manual})