From acba74a39542099bc6cc68bf60d52bb14005c2d3 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 18 Sep 2021 21:04:07 +0300 Subject: [PATCH] ; Clarify recently added documentation * etc/NEWS: * doc/emacs/help.texi (Name Help): Clarify documentation of 'help-enable-symbol-autoload'. --- doc/emacs/help.texi | 12 +++++++----- etc/NEWS | 8 +++++--- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index f7fcd207ee1..9f6009b321e 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -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 diff --git a/etc/NEWS b/etc/NEWS index a0da78a1f61..5c78189738f 100644 --- 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. -- 2.39.5