]> git.eshelyaron.com Git - emacs.git/commitdiff
Further doc string quoting fixes
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 22 Apr 2022 15:16:42 +0000 (17:16 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 22 Apr 2022 15:16:42 +0000 (17:16 +0200)
* 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
lisp/erc/erc.el
lisp/faces.el
lisp/mail/ietf-drums-date.el
lisp/net/eudc.el
lisp/org/ob-table.el
lisp/recentf.el
lisp/shell.el
lisp/simple.el
test/lisp/progmodes/cperl-mode-tests.el

index 0330a2a0abad0f814e53ea7b1c0407892f58249e..07443dabfefa091a0e014105db95a3d47c00b331 100644 (file)
@@ -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.
index 52fe106f2d11c59f52a39b6786d5dbde288ec980..06381c5ebee5da42c8fa192211235c055a172069 100644 (file)
@@ -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)))
index b4e1f03eef64bb889c2abf893c89719efba54795..962501ee7cc0ba2e9876d25184d1b68516fce6df 100644 (file)
@@ -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.")
 
index 6f64ae733777a9d5c37a143df56e2a114b3e158e..ddef7f11b667be9d2ebc5cd57688f5d1c783ecf7 100644 (file)
@@ -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.
index 6ce89ce5be4e74ddb54253b286ffc6c8176aa6dc..808d2ca509c26e423c1724aa4ffda0d00f7b07e8 100644 (file)
@@ -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."
index 2f092998d8bf338fc0a3a5aa0aa2bc7a5996d3be..f6729e0ece784df742c4465be71eef900c2fc83d 100644 (file)
@@ -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
index 5e2f22186143139e56460697bc2edb12b2b2062f..2de9831154023cbfd157c9c4fe3be2adba8970e8 100644 (file)
@@ -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
index a9990f5d5514cf56be0b2b83b760191626dd54dc..627c48e35fbaec9c642c70a94faee47b94ed89d9 100644 (file)
@@ -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."
index 323d51dd2d34051078199a8f25a9654aace54f5f..75720d895cc49e303c200484d02f40b7afbd5119 100644 (file)
@@ -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
index b8a3bd97d8d766b5e34759e4bca39ea0f53b7dc8..4e0debffb698dd2aa767736947b76787434ed362 100644 (file)
@@ -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."