Audit symbol quoting in Lisp doc strings

* lisp/vc/vc-svn.el (vc-svn-dir-status-files):
* lisp/so-long.el (so-long-mode-maintain-preserved-variables):
* lisp/help-fns.el (help-fns--most-relevant-active-keymap):
* lisp/gnus/nnselect.el (nnselect-get-artlist):
(nnselect-store-artlist):
* lisp/forms.el (forms-enumerate):
* lisp/ffap.el (ffap-string-at-point):
* lisp/emacs-lisp/byte-run.el (define-obsolete-variable-alias):
Audit symbol quoting in Lisp doc strings.
This commit is contained in:
Lars Ingebrigtsen 2022-05-24 12:36:41 +02:00
parent 54a3132cfa
commit ed34cbeae7
7 changed files with 13 additions and 13 deletions

View file

@ -534,7 +534,7 @@ made obsolete, for example a date or a release number.
This macro evaluates all its parameters, and both OBSOLETE-NAME
and CURRENT-NAME should be symbols, so a typical usage would look like:
(define-obsolete-variable-alias 'foo-thing 'bar-thing \"28.1\")
(define-obsolete-variable-alias \\='foo-thing \\='bar-thing \"28.1\")
This macro uses `defvaralias' and `make-obsolete-variable' (which see).
See the Info node `(elisp)Variable Aliases' for more details.

View file

@ -1229,13 +1229,13 @@ If the region is active, return a string from the region.
If the point is in a comment, ensure that the returned string does not
contain the comment start characters (especially for major modes that
have '//' as comment start characters).
have \"//\" as comment start characters).
Set the variables `ffap-string-at-point' and
`ffap-string-at-point-region'.
When the region is active and larger than `ffap-max-region-length',
return an empty string, and set `ffap-string-at-point-region' to '(1 1)."
return an empty string, and set `ffap-string-at-point-region' to `(1 1)'."
(let* (dir-separator
(args
(cdr

View file

@ -2009,7 +2009,7 @@ It returns the highest number.
Usage: (setq forms-number-of-fields
(forms-enumerate
'(field1 field2 field2 ...)))"
\\='(field1 field2 field2 ...)))"
(let ((the-index 0))
(while the-fields

View file

@ -291,9 +291,9 @@ parameters."
(defmacro nnselect-get-artlist (group)
"Get the list of articles for GROUP.
If the group parameter 'nnselect-get-artlist-override-function is
If the group parameter `nnselect-get-artlist-override-function' is
non-nil call this function with argument GROUP to get the
artlist; if the group parameter 'nnselect-always-regenerate is
artlist; if the group parameter `nnselect-always-regenerate' is
non-nil, regenerate the artlist; otherwise retrieve the artlist
directly from the group parameters."
`(when (gnus-nnselect-group-p ,group)
@ -310,9 +310,9 @@ directly from the group parameters."
(defmacro nnselect-store-artlist (group artlist)
"Store the ARTLIST for GROUP.
If the group parameter 'nnselect-store-artlist-override-function
If the group parameter `nnselect-store-artlist-override-function'
is non-nil call this function on GROUP and ARTLIST; if the group
parameter 'nnselect-always-regenerate is non-nil don't store the
parameter `nnselect-always-regenerate' is non-nil don't store the
artlist; otherwise store the ARTLIST in the group parameters."
`(let ((override (gnus-group-get-parameter
,group

View file

@ -1902,8 +1902,8 @@ variable with value KEYMAP."
The heuristic to determine which keymap is most likely to be
relevant to a user follows this order:
1. 'keymap' text property at point
2. 'local-map' text property at point
1. `keymap' text property at point
2. `local-map' text property at point
3. the `current-local-map'
This is used to set the default value for the interactive prompt

View file

@ -1518,14 +1518,14 @@ The variables are set in accordance with what was remembered in `so-long'."
(kill-local-variable variable))))
(defun so-long-mode-maintain-preserved-variables ()
"Set any 'preserved' variables.
"Set any \"preserved\" variables.
The variables are set in accordance with what was remembered in `so-long'."
(dolist (var (so-long-original 'so-long-mode-preserved-variables))
(so-long-restore-variable var)))
(defun so-long-mode-maintain-preserved-minor-modes ()
"Enable or disable 'preserved' minor modes.
"Enable or disable \"preserved\" minor modes.
The modes are set in accordance with what was remembered in `so-long'."
(dolist (mode (so-long-original 'so-long-mode-preserved-minor-modes))

View file

@ -212,7 +212,7 @@ switches."
(autoload 'vc-expand-dirs "vc")
(defun vc-svn-dir-status-files (_dir files callback)
"Run 'svn status' for DIR and update BUFFER via CALLBACK.
"Run \"svn status\" for DIR and update BUFFER via CALLBACK.
CALLBACK is called as (CALLBACK RESULT BUFFER), where
RESULT is a list of conses (FILE . STATE) for directory DIR."
;; FIXME shouldn't this rather default to all the files in dir?