]> git.eshelyaron.com Git - emacs.git/commitdiff
* doc/emacs/help.texi (Name Help): Mention buttons (bug#69935)
authorStefan Monnier <monnier@iro.umontreal.ca>
Sun, 24 Mar 2024 02:27:34 +0000 (22:27 -0400)
committerEshel Yaron <me@eshelyaron.com>
Sun, 24 Mar 2024 14:22:20 +0000 (15:22 +0100)
(cherry picked from commit 044558766a77b1c9b8a7e6d757ca65730a88b88d)

doc/emacs/help.texi

index 7e213018003f6e2e084d596312f0ac1877c4c707..c799e8d55ca91c29c986d814fb49763a688ae611 100644 (file)
@@ -305,6 +305,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})