emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master 2d71fd3b04: Further doc string quoting fixes


From: Lars Ingebrigtsen
Subject: master 2d71fd3b04: Further doc string quoting fixes
Date: Fri, 22 Apr 2022 11:16:55 -0400 (EDT)

branch: master
commit 2d71fd3b041506c68b5f1cd1e409e09e25778c34
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Further doc string quoting fixes
    
    * test/lisp/progmodes/cperl-mode-tests.el (cperl--run-test-cases):
    * lisp/simple.el (undo-equiv-table):
    * lisp/shell.el (shell-mode):
    (shell-mode):
    * lisp/recentf.el (recentf-mode):
    * lisp/org/ob-table.el (org-sbe):
    * lisp/net/eudc.el (eudc-rfc5322-cctext-token):
    * lisp/mail/ietf-drums-date.el (ietf-drums-date--slot-ranges):
    * lisp/faces.el (color-luminance-dark-limit):
    * lisp/erc/erc.el (erc-tls):
    * lisp/emacs-lisp/pcase.el (pcase-setq): Further quoting fixes in
    doc strings.
---
 lisp/emacs-lisp/pcase.el                | 2 +-
 lisp/erc/erc.el                         | 2 +-
 lisp/faces.el                           | 4 ++--
 lisp/mail/ietf-drums-date.el            | 4 ++--
 lisp/net/eudc.el                        | 2 +-
 lisp/org/ob-table.el                    | 2 +-
 lisp/recentf.el                         | 2 +-
 lisp/shell.el                           | 4 ++--
 lisp/simple.el                          | 4 ++--
 test/lisp/progmodes/cperl-mode-tests.el | 2 +-
 10 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el
index 0330a2a0ab..07443dabfe 100644
--- a/lisp/emacs-lisp/pcase.el
+++ b/lisp/emacs-lisp/pcase.el
@@ -328,7 +328,7 @@ PATTERNS are normal `pcase' patterns, and VALUES are 
expression.
 
 Evaluation happens sequentially as in `setq' (not in parallel).
 
-An example: (pcase-setq `((,a) [(,b)]) '((1) [(2)]))
+An example: (pcase-setq \\=`((,a) [(,b)]) \\='((1) [(2)]))
 
 VAL is presumed to match PAT.  Failure to match may signal an error or go
 undetected, binding variables to arbitrary values, such as nil.
diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el
index 52fe106f2d..06381c5ebe 100644
--- a/lisp/erc/erc.el
+++ b/lisp/erc/erc.el
@@ -2269,7 +2269,7 @@ Example usage:
 
     (erc-tls :server \"irc.libera.chat\" :port 6697
              :client-certificate
-             '(\"/home/bandali/my-cert.key\"
+             \\='(\"/home/bandali/my-cert.key\"
                \"/home/bandali/my-cert.crt\"))"
   (interactive (let ((erc-default-port erc-default-port-tls))
                 (erc-select-read-args)))
diff --git a/lisp/faces.el b/lisp/faces.el
index b4e1f03eef..962501ee7c 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -1858,8 +1858,8 @@ on which one provides better contrast with COLOR."
       "#ffffff" "black"))
 
 (defconst color-luminance-dark-limit 0.325
-  "The relative luminance below which a color is considered 'dark'.
-A 'dark' color in this sense provides better contrast with white
+  "The relative luminance below which a color is considered \"dark\".
+A \"dark\" color in this sense provides better contrast with white
 than with black; see `color-dark-p'.
 This value was determined experimentally.")
 
diff --git a/lisp/mail/ietf-drums-date.el b/lisp/mail/ietf-drums-date.el
index 6f64ae7337..ddef7f11b6 100644
--- a/lisp/mail/ietf-drums-date.el
+++ b/lisp/mail/ietf-drums-date.el
@@ -50,8 +50,8 @@ See the decoded-time defstruct.")
   '((0 60) (0 59) (0 23) (1 31) (1 12) (1 9999))
   "Numeric slot ranges, for bounds checking.
 Note that RFC5322 explicitly requires that seconds go up to 60,
-to allow for leap seconds (see Mills, D., 'Network Time
-Protocol', STD 12, RFC 1119, September 1989).")
+to allow for leap seconds (see Mills, D., \"Network Time
+Protocol\", STD 12, RFC 1119, September 1989).")
 
 (defsubst ietf-drums-date--ignore-char-p (char)
   ;; Ignore whitespace and commas.
diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el
index 6ce89ce5be..808d2ca509 100644
--- a/lisp/net/eudc.el
+++ b/lisp/net/eudc.el
@@ -174,7 +174,7 @@ Value is the new string."
   "Folding white space.")
 
 (defconst eudc-rfc5322-cctext-token "\u005D-\u007E\u002A-\u005B\u0021-\u0027"
-  "Printable US-ASCII characters not including '(', ')', or '\\'.")
+  "Printable US-ASCII characters not including \"(\", \")\", or \"\\\".")
 
 (defun eudc-rfc5322-quote-phrase (string)
   "Quote STRING if it needs quoting as a phrase in a header."
diff --git a/lisp/org/ob-table.el b/lisp/org/ob-table.el
index 2f092998d8..f6729e0ece 100644
--- a/lisp/org/ob-table.el
+++ b/lisp/org/ob-table.el
@@ -84,7 +84,7 @@ is the equivalent of the following source code block:
  #+end_src
 
 NOTE: The quotation marks around the function name,
-'source-block', are optional.
+`source-block', are optional.
 
 NOTE: By default, string variable names are interpreted as
 references to source-code blocks, to force interpretation of a
diff --git a/lisp/recentf.el b/lisp/recentf.el
index 5e2f221861..2de9831154 100644
--- a/lisp/recentf.el
+++ b/lisp/recentf.el
@@ -1353,7 +1353,7 @@ to a file, and killing a buffer is counted as 
\"operating\" on
 the file.  If instead you want to prioritize files that appear in
 buffers you switch to a lot, you can say something like the following:
 
-  (add-hook 'buffer-list-update-hook 'recentf-track-opened-file)"
+  (add-hook \\='buffer-list-update-hook #\\='recentf-track-opened-file)"
   :global t
   :group 'recentf
   :keymap recentf-mode-map
diff --git a/lisp/shell.el b/lisp/shell.el
index a9990f5d55..627c48e35f 100644
--- a/lisp/shell.el
+++ b/lisp/shell.el
@@ -528,7 +528,7 @@ Shell buffers.  It implements `shell-completion-execonly' 
for
     the shell.  This is useful for entering passwords.  Or, add the function
     `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
 
-If you want to make multiple shell buffers, rename the `*shell*' buffer
+If you want to make multiple shell buffers, rename the \"*shell*\" buffer
 using \\[rename-buffer] or \\[rename-uniquely] and start a new shell.
 
 If you want to make shell buffers limited in length, add the function
@@ -575,7 +575,7 @@ buffer.
 
 By default, shell mode does nothing special when it receives a
 \"bell\" character (C-g or ^G).  If you
-  (add-hook 'comint-output-filter-functions 'shell-filter-ring-bell nil t)
+  (add-hook \\='comint-output-filter-functions #\\='shell-filter-ring-bell nil 
t)
 from `shell-mode-hook', Emacs will call the `ding' function
 whenever it receives the bell character in output from a
 command."
diff --git a/lisp/simple.el b/lisp/simple.el
index 323d51dd2d..75720d895c 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -3008,12 +3008,12 @@ the minibuffer contents."
 
 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
   "Table mapping redo records to the corresponding undo one.
-A redo record for an undo in region maps to 'undo-in-region.
+A redo record for an undo in region maps to `undo-in-region'.
 A redo record for ordinary undo maps to the following (earlier) undo.
 A redo record that undoes to the beginning of the undo list maps to t.
 In the rare case where there are (erroneously) consecutive nil's in
 `buffer-undo-list', `undo' maps the previous valid undo record to
-'empty, if the previous record is a redo record, `undo' doesn't change
+`empty', if the previous record is a redo record, `undo' doesn't change
 its mapping.
 
 To be clear, a redo record is just an undo record, the only difference
diff --git a/test/lisp/progmodes/cperl-mode-tests.el 
b/test/lisp/progmodes/cperl-mode-tests.el
index b8a3bd97d8..4e0debffb6 100644
--- a/test/lisp/progmodes/cperl-mode-tests.el
+++ b/test/lisp/progmodes/cperl-mode-tests.el
@@ -64,7 +64,7 @@ The expected output from running BODY on the input goes here.
 # -------- NAME: end --------
 
 You can have many of these blocks in one test file.  You can
-chose a NAME for each block, which is passed to the 'should'
+chose a NAME for each block, which is passed to the `should'
 clause for easy identification of the first test case that
 failed (if any).  Text outside these the blocks is ignored by the
 tests, so you can use it to document the test cases if you wish."



reply via email to

[Prev in Thread] Current Thread [Next in Thread]