Further audits of single quotes in Lisp doc strings

* test/manual/etags/el-src/emacs/lisp/progmodes/etags.el
(tags-apropos-additional-actions):
* lisp/window.el (delete-window-choose-selected):
* lisp/vc/ediff-merg.el (ediff-combination-pattern):
* lisp/vc/diff.el (diff-no-select):
* lisp/tab-bar.el (tab-bar-new-tab-choice):
* lisp/simple.el (next-error-message-highlight):
(backward-delete-char-untabify):
* lisp/ses.el (ses-jump-cell-name-function):
* lisp/org/org.el (org-latex-to-html-convert-command):
* lisp/org/org-agenda.el (org-agenda-sorting-strategy):
* lisp/net/tramp.el (tramp-default-file-modes):
* lisp/net/newst-treeview.el
(newsticker-treeview-use-feed-name-from-url-list-in-treeview):
* lisp/net/eww.el (eww-auto-rename-buffer):
* lisp/mwheel.el (mouse-wheel-scroll-amount):
* lisp/mail/rmail.el (rmail-re-abbrevs):
* lisp/info.el (Info-history-forward-menu):
* lisp/gnus/nnselect.el (nnselect-retrieve-headers-override-function):
* lisp/gnus/gnus-start.el (gnus-subscribe-hierarchical-interactive):
* lisp/fringe.el (fboundp):
* lisp/eshell/esh-var.el (eshell-variable-aliases-list):
* lisp/emacs-lisp/checkdoc.el (checkdoc-column-zero-backslash-before-paren):
* lisp/dired-aux.el (dired-confirm-shell-command):
* lisp/calendar/calendar.el (calendar-time-zone-style):
* lisp/ansi-color.el (ansi-color-faces-vector):
(ansi-color-names-vector): Audit use of various single quotes in
Lisp doc strings.
This commit is contained in:
Lars Ingebrigtsen 2022-05-24 13:17:53 +02:00
parent ed34cbeae7
commit b2bce107b1
24 changed files with 36 additions and 36 deletions

View file

@ -234,7 +234,7 @@ This vector holds the faces used for SGR control sequence parameters 0
to 7.
This variable is obsolete. To customize the display of faces used by
ansi-color, change 'ansi-color-FACE', e.g. `ansi-color-bold'. To
ansi-color, change `ansi-color-FACE', e.g. `ansi-color-bold'. To
customize the actual faces used (e.g. to temporarily display SGR
control sequences differently), use `ansi-color-basic-faces-vector'."
:type '(vector face face face face face face face face)
@ -249,7 +249,7 @@ This vector holds the colors used for SGR control sequence parameters
30 to 37 (foreground colors) and 40 to 47 (background colors).
This variable is obsolete. To customize the display of colors used by
ansi-color, change 'ansi-color-COLOR', e.g. `ansi-color-red'. To
ansi-color, change `ansi-color-COLOR', e.g. `ansi-color-red'. To
customize the actual faces used (e.g. to temporarily display SGR
control sequences differently), use `ansi-color-normal-colors-vector'."
:type '(vector (choice color (cons color color))

View file

@ -1066,7 +1066,7 @@ calendar."
;; fixme should have a :set that changes calendar-standard-time-zone-name etc.
(defcustom calendar-time-zone-style 'symbolic
"Your preferred style for time zones.
If 'numeric, use numeric time zones like \"+0100\".
If `numeric', use numeric time zones like \"+0100\".
Otherwise, use symbolic time zones like \"CET\"."
:type '(choice (const numeric) (other symbolic))
:version "28.1"

View file

@ -797,7 +797,7 @@ offer a smarter default choice of shell command."
;;;###autoload
(defcustom dired-confirm-shell-command t
"Whether to prompt for confirmation for dired-do-shell-command.
"Whether to prompt for confirmation for `dired-do-shell-command'.
If non-nil, prompt for confirmation if the command contains potentially
dangerous characters. If nil, never prompt for confirmation."
:type 'boolean

View file

@ -327,7 +327,7 @@ This should be set in an Emacs Lisp file's local variables."
;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable #'checkdoc-list-of-strings-p)
(defcustom checkdoc-column-zero-backslash-before-paren t
"Non-nil means to warn if there is no '\\' before '(' in column zero.
"Non-nil means to warn if there is no \"\\\" before \"(\" in column zero.
This backslash is no longer needed on Emacs 27.1 or later.
See Info node `(elisp) Documentation Tips' for background."

View file

@ -185,7 +185,7 @@ list of the indices that was used in the reference, and whether the
user is requesting the length of the ultimate element. For example, a
reference of `$NAME[10][20]' would result in the function for alias
`NAME' being called (assuming it were aliased to a function), and the
arguments passed to this function would be the list '(10 20)', and
arguments passed to this function would be the list `(10 20)', and
nil.
If the value is a string, return the value for the variable with that

View file

@ -314,7 +314,7 @@ BITMAP is a symbol identifying the new fringe bitmap.
BITS is either a string or a vector of integers.
HEIGHT is height of bitmap. If HEIGHT is nil, use length of BITS.
WIDTH must be an integer between 1 and 16, or nil which defaults to 8.
Optional fifth arg ALIGN may be one of top, center, or bottom,
Optional fifth arg ALIGN may be one of `top', `center', or `bottom',
indicating the positioning of the bitmap relative to the rows where it
is used; the default is to center the bitmap. Fifth arg may also be a
list (ALIGN PERIODIC) where PERIODIC non-nil specifies that the bitmap

View file

@ -329,10 +329,10 @@ with the subscription method in this variable."
"If non-nil, Gnus will offer to subscribe hierarchically.
When a new hierarchy appears, Gnus will ask the user:
'alt.binaries': Do you want to subscribe to this hierarchy? ([d]ys):
Descend hierarchy alt.binaries? ([y]nsq):
If the user pressed `d', Gnus will descend the hierarchy, `y' will
subscribe to all newsgroups in the hierarchy and `s' will skip this
If the user pressed `y', Gnus will descend the hierarchy, `s' will
subscribe to all newsgroups in the hierarchy and `n' will skip this
hierarchy in its entirety."
:group 'gnus-group-new
:type 'boolean)

View file

@ -260,7 +260,7 @@ as `(keyfunc member)' and the corresponding element is just
(defcustom nnselect-retrieve-headers-override-function nil
"A function that retrieves article headers for ARTICLES from GROUP.
The retrieved headers should populate the `nntp-server-buffer'.
Returns either the retrieved header format 'nov or 'headers.
Returns either the retrieved header format `nov' or `headers'.
If this variable is nil, or if the provided function returns nil,
`gnus-retrieve-headers' will be called instead."

View file

@ -4236,7 +4236,7 @@ If FORK is non-nil, it is passed to `Info-goto-node'."
(Info-history-menu e "Back in history" Info-history 'Info-history-back))
(defun Info-history-forward-menu (e)
"Pop up the menu with a list of Info nodes visited with Info-history-back."
"Pop up the menu with a list of Info nodes visited with `Info-history-back'."
(interactive "e" Info-mode)
(Info-history-menu e "Forward in history" Info-history-forward 'Info-history-forward))

View file

@ -537,7 +537,7 @@ Examples:
;; Note: this is matched with case-fold-search bound to t.
(defcustom rmail-re-abbrevs
"\\(RE\\|رد\\|回复\\|回覆\\|SV\\|Antw\\|VS\\|REF\\|AW\\|ΑΠ\\|ΣΧΕΤ\\|השב\\|Vá\\|R\\|RIF\\|BLS\\|RES\\|Odp\\|YNT\\|ATB\\)"
"Regexp with localized 'Re:' abbreviations in various languages."
"Regexp with localized \"Re:\" abbreviations in various languages."
:version "28.1"
:type 'regexp)

View file

@ -902,10 +902,10 @@ If the value is t, the *Completions* buffer is displayed whenever completion
is requested but cannot be done.
If the value is `lazy', the *Completions* buffer is only displayed after
the second failed attempt to complete.
If the value is 'always', the *Completions* buffer is always shown
If the value is `always', the *Completions* buffer is always shown
after a completion attempt, and the list of completions is updated if
already visible.
If the value is 'visible', the *Completions* buffer is displayed
If the value is `visible', the *Completions* buffer is displayed
whenever completion is requested but cannot be done for the first time,
but remains visible thereafter, and the list of completions in it is
updated for subsequent attempts to complete.."

View file

@ -124,10 +124,10 @@ screen. It can also be a floating point number, specifying the fraction of
a full screen to scroll. A near full screen is `next-screen-context-lines'
less than a full screen.
If AMOUNT is the symbol 'hscroll', this means that with MODIFIER,
If AMOUNT is the symbol `hscroll', this means that with MODIFIER,
the mouse wheel will scroll horizontally instead of vertically.
If AMOUNT is the symbol 'text-scale', this means that with
If AMOUNT is the symbol `text-scale', this means that with
MODIFIER, the mouse wheel will change the face height instead of
scrolling."
:group 'mouse

View file

@ -192,7 +192,7 @@ determine the renaming scheme, as follows:
user-defined function:
(defun my-eww-rename-buffer ()
(when (eq major-mode 'eww-mode)
(when (eq major-mode \\='eww-mode)
(when-let ((string (or (plist-get eww-data :title)
(plist-get eww-data :url))))
(format \"*%s*\" string))))

View file

@ -106,13 +106,13 @@ applies to newsticker only."
(defcustom newsticker-treeview-use-feed-name-from-url-list-in-treeview
t
"Use the feed names from 'newsticker-url-list' for display in treeview."
"Use the feed names from `newsticker-url-list' for display in treeview."
:version "28.1"
:type 'boolean)
(defcustom newsticker-treeview-use-feed-name-from-url-list-in-itemview
t
"Use feed names from 'newsticker-url-list' in itemview."
"Use feed names from `newsticker-url-list' in itemview."
:version "28.1"
:type 'boolean)

View file

@ -2483,7 +2483,7 @@ For definition of that list see `tramp-set-completion-function'."
(defun tramp-default-file-modes (filename &optional flag)
"Return file modes of FILENAME as integer.
If optional FLAG is nofollow, do not follow FILENAME if it is a
If optional FLAG is `nofollow', do not follow FILENAME if it is a
symbolic link. If the file modes of FILENAME cannot be
determined, return the value of `default-file-modes', without
execute permissions."

View file

@ -1615,7 +1615,7 @@ alpha-down Sort headlines alphabetically, reversed.
The different possibilities will be tried in sequence, and testing stops
if one comparison returns a \"not-equal\". For example, the default
'(time-up category-keep priority-down)
`(time-up category-keep priority-down)'
means: Pull out all entries having a specified time of day and sort them,
in order to make a time schedule for the current day the first thing in the
agenda listing for the day. Of the entries without a time indication, keep

View file

@ -3301,7 +3301,7 @@ Replace format-specifiers in the command as noted below and use
%i: The LaTeX fragment to be converted.
For example, this could be used with LaTeXML as
\"latexmlc 'literal:%i' --profile=math --preload=siunitx.sty 2>/dev/null\"."
\"latexmlc \\='literal:%i\\=' --profile=math --preload=siunitx.sty 2>/dev/null\"."
:group 'org-latex
:package-version '(Org . "9.4")
:type '(choice

View file

@ -108,9 +108,9 @@ Each function is called with ARG=1."
:type 'hook)
(defcustom ses-jump-cell-name-function #'upcase
"Function to process the string passed to function ses-jump.
Set it to 'identity to make no change.
Set it to 'upcase to make cell name change case isensitive.
"Function to process the string passed to function `ses-jump'.
Set it to `identity' to make no change.
Set it to `upcase' to make cell name change case isensitive.
May return
@ -119,8 +119,8 @@ Set it to 'upcase to make cell name change case isensitive.
:type 'function)
(defcustom ses-jump-prefix-function #'ses-jump-prefix
"Function that takes the prefix argument passed to function ses-jump.
It may return the same sort of thing as ses-jump-cell-name-function."
"Function that takes the prefix argument passed to function `ses-jump'.
It may return the same sort of thing as `ses-jump-cell-name-function'."
:type 'function)

View file

@ -512,7 +512,7 @@ buffer causes automatic display of the corresponding source code location."
(error t))))
(defun next-error-message-highlight (error-buffer)
"Highlight the current error message in the next-error buffer."
"Highlight the current error message in the `next-error' buffer."
(when next-error-message-highlight
(with-current-buffer error-buffer
(when (and next-error--message-highlight-overlay
@ -6304,7 +6304,7 @@ Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
If Transient Mark mode is enabled, the mark is active, and ARG is 1,
delete the text in the region and deactivate the mark instead.
To disable this, set option delete-active-region to nil.
To disable this, set option `delete-active-region' to nil.
Interactively, ARG is the prefix arg (default 1)
and KILLP is t if a prefix arg was specified."

View file

@ -476,7 +476,7 @@ that was current before calling the command that adds a new tab
(this is the same what `make-frame' does by default).
If the value is the symbol `window', then keep the selected
window as a single window on the new tab, and keep all its
window parameters except 'window-atom' and 'window-side'.
window parameters except `window-atom' and `window-side'.
If the value is a string, use it as a buffer name to switch to
if such buffer exists, or switch to a buffer visiting the file or
directory that the string specifies. If the value is a function,

View file

@ -153,7 +153,7 @@ Possible values are:
;; Noninteractive helper for creating and reverting diff buffers
"Compare the OLD and NEW file/buffer.
If the optional SWITCHES is nil, the switches specified in the
variable diff-switches are passed to the diff command,
variable `diff-switches' are passed to the diff command,
otherwise SWITCHES is used. SWITCHES can be a string or a list
of strings.

View file

@ -54,7 +54,7 @@ Valid values are the symbols `default-A', `default-B', and `combined'."
The value must be a list of the form
\(STRING1 bufspec1 STRING2 bufspec2 STRING3 bufspec3 STRING4)
where bufspec is the symbol A, B, or Ancestor. For instance, if the value is
'(STRING1 A STRING2 Ancestor STRING3 B STRING4) then the
`(STRING1 A STRING2 Ancestor STRING3 B STRING4)' then the
combined text will look like this:
STRING1

View file

@ -4181,8 +4181,8 @@ another live window on that frame to serve as its selected
window. This option allows to control which window gets selected
instead.
The possible choices are 'mru' (the default) to select the most
recently used window on that frame, and 'pos' to choose the
The possible choices are `mru' (the default) to select the most
recently used window on that frame, and `pos' to choose the
window at the frame coordinates of point of the previously
selected window. If this is nil, choose the frame's first window
instead. A window with a non-nil `no-other-window' parameter is

View file

@ -171,7 +171,7 @@ is the symbol being selected.
Example value:
'((\"Emacs Lisp\" Info-goto-emacs-command-node obarray)
\\='((\"Emacs Lisp\" Info-goto-emacs-command-node obarray)
(\"Common Lisp\" common-lisp-hyperspec common-lisp-hyperspec-obarray)
(\"SCWM\" scwm-documentation scwm-obarray))"
:group 'etags