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

; Improve documentation of 'help-fns-edit-variable'

Browse source 
* lisp/help-fns.el (help-fns-edit-variable)
(help-enable-variable-value-editing): Doc fixes.
This commit is contained in:
Eli Zaretskii 2025-04-16 11:13:41 +03:00
parent 179c6931c5
commit bf737dc42a
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lisp/help-fns.el
View file

@ -135,11 +135,11 @@ with the current prefix. The files are chosen according to
:version "26.3")
(defcustom help-enable-variable-value-editing nil
"If non-nil, allow editing values in *Help* buffers.
"If non-nil, allow editing variable values in *Help* buffers.
To edit the value of a variable, use \\[describe-variable] to
display a \"*Help*\" buffer, move point after the text
\"Its value is\" and type \\`e'.
\"Its value is\" and type \\`e' to invoke `help-fns-edit-variable'.
Values that aren't readable by the Emacs Lisp reader can't be
edited even if this option is enabled."
@ -1555,7 +1555,16 @@ it is displayed along with the global value."
(put 'help-fns-edit-variable 'disabled t)
(defun help-fns-edit-variable ()
"Edit the variable under point."
"Edit the variable value at point in \"*Help*\" buffer.
This command only works if `help-enable-variable-value-editing' is non-nil.
To edit the value of a variable, use \\[describe-variable] followed by the name
of a variable, to display a \"*Help*\" buffer, move point to
the variable's value, usually after the text \"Its value is\", and
type \\`e' to invoke this command.
Values that aren't readable by the Emacs Lisp reader can't be edited
by this command."
(declare (completion ignore))
(interactive)
(let ((var (get-text-property (point) 'help-fns--edit-variable)))