1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-21 06:55:39 +00:00

Pacify some docstring control char warnings

Other instances are discussed in the following thread:
https://lists.gnu.org/r/emacs-devel/2024-02/msg00797.html

* lisp/allout.el (allout-command-prefix): Declare :type as
key-sequence.  Mark up key sequences in docstring.
* lisp/auth-source.el (auth-source--decode-octal-string):
* lisp/ffap.el (ffap-search-backward-file-end):
* lisp/gnus/gnus-art.el (gnus-page-delimiter):
* lisp/gnus/nnheader.el (nnheader-strip-cr):
* lisp/proced.el (proced-log):
* lisp/progmodes/idlw-shell.el (idlwave-shell-prompt-pattern):
* lisp/url/url-http.el (url-http-clean-headers):
* lisp/vcursor.el (vcursor-interpret-input): Quote control
characters in docstrings.
This commit is contained in:
Basil L. Contovounesios 2024-02-28 16:38:21 +01:00
parent e490d2f872
commit f7c2fe3337
9 changed files with 13 additions and 13 deletions

View File

@ -161,9 +161,9 @@ respective `allout-mode' keybinding variables, `allout-command-prefix',
(defcustom allout-command-prefix "\C-c " (defcustom allout-command-prefix "\C-c "
"Key sequence to be used as prefix for outline mode command key bindings. "Key sequence to be used as prefix for outline mode command key bindings.
Default is `\C-c<space>'; just `\C-c' is more short-and-sweet, if you're Default is \\`C-c SPC'; just \\`C-c' is more short-and-sweet, if you're
willing to let allout use a bunch of \C-c keybindings." willing to let allout use a bunch of \\`C-c' keybindings."
:type 'string :type 'key-sequence
:group 'allout-keybindings :group 'allout-keybindings
:set #'allout-compose-and-institute-keymap) :set #'allout-compose-and-institute-keymap)
;;;_ = allout-keybindings-binding ;;;_ = allout-keybindings-binding

View File

@ -1985,7 +1985,7 @@ entries for git.gnus.org:
(defun auth-source--decode-octal-string (string) (defun auth-source--decode-octal-string (string)
"Convert octal STRING to utf-8 string. E.g: \"a\134b\" to \"a\b\"." "Convert octal STRING to utf-8 string. E.g.: \"a\\134b\" to \"a\\b\"."
(let ((list (string-to-list string)) (let ((list (string-to-list string))
(size (length string))) (size (length string)))
(decode-coding-string (decode-coding-string

View File

@ -1098,12 +1098,12 @@ Suppose the cursor is somewhere that might be near end of file,
the guessing would position point before punctuation (like comma) the guessing would position point before punctuation (like comma)
after the file extension: after the file extension:
C:\temp\file.log, which contain .... C:\\temp\\file.log, which contain ....
=============================== (before) =============================== (before)
---------------- (after) ---------------- (after)
C:\temp\file.log on Windows or /tmp/file.log on Unix C:\\temp\\file.log on Windows or /tmp/file.log on Unix
=============================== (before) =============================== (before)
---------------- (after) ---------------- (after)

View File

@ -694,7 +694,7 @@ used as possible file names."
(defcustom gnus-page-delimiter "^\^L" (defcustom gnus-page-delimiter "^\^L"
"Regexp describing what to use as article page delimiters. "Regexp describing what to use as article page delimiters.
The default value is \"^\^L\", which is a form linefeed at the The default value is \"^\\^L\", which is a form linefeed at the
beginning of a line." beginning of a line."
:type 'regexp :type 'regexp
:group 'gnus-article-various) :group 'gnus-article-various)

View File

@ -1016,7 +1016,7 @@ See `find-file-noselect' for the arguments."
(nnheader-skeleton-replace from to t)) (nnheader-skeleton-replace from to t))
(defun nnheader-strip-cr () (defun nnheader-strip-cr ()
"Strip all \r's from the current buffer." "Strip all \\r's from the current buffer."
(nnheader-skeleton-replace "\r")) (nnheader-skeleton-replace "\r"))
(define-obsolete-function-alias 'nnheader-cancel-timer 'cancel-timer "27.1") (define-obsolete-function-alias 'nnheader-cancel-timer 'cancel-timer "27.1")

View File

@ -2261,7 +2261,7 @@ If LOG is a string and there are more args, it is formatted with
those ARGS. Usually the LOG string ends with a \\n. those ARGS. Usually the LOG string ends with a \\n.
End each bunch of errors with (proced-log t signal): End each bunch of errors with (proced-log t signal):
this inserts the current time, buffer and signal at the start of the page, this inserts the current time, buffer and signal at the start of the page,
and \f (formfeed) at the end." and \\f (formfeed) at the end."
(let ((obuf (current-buffer))) (let ((obuf (current-buffer)))
(with-current-buffer (get-buffer-create proced-log-buffer) (with-current-buffer (get-buffer-create proced-log-buffer)
(goto-char (point-max)) (goto-char (point-max))

View File

@ -96,8 +96,8 @@
(defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> " (defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> "
"Regexp to match IDL prompt at beginning of a line. "Regexp to match IDL prompt at beginning of a line.
For example, \"^\r?IDL> \" or \"^\r?WAVE> \". For example, \"^\\r?IDL> \" or \"^\\r?WAVE> \".
The \"^\r?\" is needed, to indicate the beginning of the line, with The \"^\\r?\" is needed, to indicate the beginning of the line, with
optional return character (which IDL seems to output randomly). optional return character (which IDL seems to output randomly).
This variable is used to initialize `comint-prompt-regexp' in the This variable is used to initialize `comint-prompt-regexp' in the
process buffer." process buffer."

View File

@ -427,7 +427,7 @@ Use `url-http-referer' as the Referer-header (subject to `url-privacy-level')."
;; Parsing routines ;; Parsing routines
(defun url-http-clean-headers () (defun url-http-clean-headers ()
"Remove trailing \r from header lines. "Remove trailing \\r from header lines.
This allows us to use `mail-fetch-field', etc. This allows us to use `mail-fetch-field', etc.
Return the number of characters removed." Return the number of characters removed."
(let ((end (marker-position url-http-end-of-headers))) (let ((end (marker-position url-http-end-of-headers)))

View File

@ -433,7 +433,7 @@ Default is nil."
(defcustom vcursor-interpret-input nil (defcustom vcursor-interpret-input nil
"If non-nil, input from the vcursor is treated as interactive input. "If non-nil, input from the vcursor is treated as interactive input.
This will cause text insertion to be much slower. Note that no special This will cause text insertion to be much slower. Note that no special
interpretation of strings is done: \"\C-x\" is a string of four interpretation of strings is done: \"\\C-x\" is a string of four
characters. The default is simply to copy strings." characters. The default is simply to copy strings."
:type 'boolean :type 'boolean
:version "20.3") :version "20.3")