]> git.eshelyaron.com Git - emacs.git/commitdiff
Further audits of single quotes in Lisp doc strings
authorLars Ingebrigtsen <larsi@gnus.org>
Tue, 24 May 2022 11:17:53 +0000 (13:17 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Tue, 24 May 2022 11:17:53 +0000 (13:17 +0200)
* 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.

24 files changed:
lisp/ansi-color.el
lisp/calendar/calendar.el
lisp/dired-aux.el
lisp/emacs-lisp/checkdoc.el
lisp/eshell/esh-var.el
lisp/fringe.el
lisp/gnus/gnus-start.el
lisp/gnus/nnselect.el
lisp/info.el
lisp/mail/rmail.el
lisp/minibuffer.el
lisp/mwheel.el
lisp/net/eww.el
lisp/net/newst-treeview.el
lisp/net/tramp.el
lisp/org/org-agenda.el
lisp/org/org.el
lisp/ses.el
lisp/simple.el
lisp/tab-bar.el
lisp/vc/diff.el
lisp/vc/ediff-merg.el
lisp/window.el
test/manual/etags/el-src/emacs/lisp/progmodes/etags.el

index b273e1f6340dc7b4dbb9f58424ddfa23ece4517b..d5db9ecfed08ce8cfd7b37e3b8bd5ffe64831f95 100644 (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))
index 7804ce0ee94b5ff83052a70d8a107c763b799ea2..9a77ae72d02ea77d90e1290458f410ab1fc4aa8e 100644 (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"
index d87d617ed7f29b05fb10dbbc32d439c0cae8c9af..4faf9431aa37a91a9178378e10cc22f17bf79acc 100644 (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
index 2554948890afd482a1481b47018d6517035393fb..346c20c590cbfdca90c07e7cdece97af86789a5b 100644 (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."
index 1c28d24af126936c7f281ac8c6346d89e8b5e1a1..186f6358bca52eb748587e15c7f9f0793ba314bd 100644 (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
index 1cfcce4542ab50ff504da45960675359461bd977..2fcdc9be070d4d6dcb9c5e4019202cdcafcedbf4 100644 (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
index dd9c277805682cbed060146b3b378a3a6fa032ed..7b5721fafbbe4fe9d3b57df8549e8db6bf81d10e 100644 (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)
index b081b1c8f9b956788ff40ce809ee741d43d5c83f..9b8333a7c6c6f46cef3ba63d25d2b898536c49d3 100644 (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."
index e51f0b9537a17032dbf0c7d83bc4d66d2051ef33..f9d63b0f32d64e26bc38666cef0c8fc6cac9f4b3 100644 (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))
 
index 8cde590bc003b324e53483297d24e96285fc289a..adb61aa09db800046926cea6a15d1f51db1c21e2 100644 (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)
 
index ee00f96b520d413b52dc7543b1e8c54c58482ff8..8287007d32288373c41a9189ae123b3211e29143 100644 (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.."
index 55d3c7a5d827a9f792ae82993543d367f7a5f0c2..be493b36534a57255b0e629d6bc51b61ff7b7ba5 100644 (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
index 21f6e33b0d2b432a85da790cec9693c588ca738e..8f02be12ff839bca4cd03a333dca9856d3af8857 100644 (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))))
index 21e5a02da39b6f74460f58512e238254b73328fb..b429a33dec8f150df0ea5b93739d17b359859b89 100644 (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)
 
index b06147599c16aa9015aa8216c6a2c8e58898c7c4..ef1e4206b6cdbc8c4ea234a7b324185e649c8898 100644 (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."
index dfd5d829db265a500b56f7d81d9e7436de9548f8..a43b083d5361ffbdeaf5dc854c416108b1c34a8d 100644 (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
index 8294e57732122236f63acb139b1f40c862ac3a30..0dfd53a3a7225fa1503ffb0812e15ac799d2cc97 100644 (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
index 7a9b35d749a1d0bd0bb52731206f2bc73e38cc26..ba965ff8a5ba279945b45336ea1f53c17eab561f 100644 (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)
 
 
index fb1bf3fa742d4d50196a9b73a4ad396772b13418..1efd900030e19904889fd14280b8998b5e3bf470 100644 (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."
index ddab71c52c439cef7d609aecae7e5b894db48bce..705b0725012e5029c63a7c3b9b7e47607506c83d 100644 (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,
index 926993eebb72fc3f804e9d3ba8d1e9e7179c154b..3e35a3329b1495cf5bb1f0bb1da4cbeb05660486 100644 (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.
 
index de8c587b1ca92b829dbef82602071d0ea992039b..aae6ad549eae80cbb93c4774ca3034f4b35e502d 100644 (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
index 585c64e687a8500a99079b4c7d8838f9828fbe1c..7f1265b9aceccdb5a3d837c209384307b3cd25c5 100644 (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
index e589263dc3f4bb5727d5aa7d179e87115f5884a7..9ae80149559bfb646d68b4a0ba75a39bec7839de 100644 (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