diff options
| author | Basil L. Contovounesios | 2024-02-28 16:38:21 +0100 |
|---|---|---|
| committer | Basil L. Contovounesios | 2024-02-28 17:04:20 +0100 |
| commit | f7c2fe3337bb5e5721d17f40f79dbc1275e17b0d (patch) | |
| tree | 0842d838e15addbfca456318b882e279f9bf6fc5 | |
| parent | e490d2f8724c5e47d83c40c388f60e84f541dae5 (diff) | |
| download | emacs-f7c2fe3337bb5e5721d17f40f79dbc1275e17b0d.tar.gz emacs-f7c2fe3337bb5e5721d17f40f79dbc1275e17b0d.zip | |
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.
| -rw-r--r-- | lisp/allout.el | 6 | ||||
| -rw-r--r-- | lisp/auth-source.el | 2 | ||||
| -rw-r--r-- | lisp/ffap.el | 4 | ||||
| -rw-r--r-- | lisp/gnus/gnus-art.el | 2 | ||||
| -rw-r--r-- | lisp/gnus/nnheader.el | 2 | ||||
| -rw-r--r-- | lisp/proced.el | 2 | ||||
| -rw-r--r-- | lisp/progmodes/idlw-shell.el | 4 | ||||
| -rw-r--r-- | lisp/url/url-http.el | 2 | ||||
| -rw-r--r-- | lisp/vcursor.el | 2 |
9 files changed, 13 insertions, 13 deletions
diff --git a/lisp/allout.el b/lisp/allout.el index a7121efb14a..e3fe8d08841 100644 --- a/lisp/allout.el +++ b/lisp/allout.el | |||
| @@ -161,9 +161,9 @@ respective `allout-mode' keybinding variables, `allout-command-prefix', | |||
| 161 | (defcustom allout-command-prefix "\C-c " | 161 | (defcustom allout-command-prefix "\C-c " |
| 162 | "Key sequence to be used as prefix for outline mode command key bindings. | 162 | "Key sequence to be used as prefix for outline mode command key bindings. |
| 163 | 163 | ||
| 164 | Default is `\C-c<space>'; just `\C-c' is more short-and-sweet, if you're | 164 | Default is \\`C-c SPC'; just \\`C-c' is more short-and-sweet, if you're |
| 165 | willing to let allout use a bunch of \C-c keybindings." | 165 | willing to let allout use a bunch of \\`C-c' keybindings." |
| 166 | :type 'string | 166 | :type 'key-sequence |
| 167 | :group 'allout-keybindings | 167 | :group 'allout-keybindings |
| 168 | :set #'allout-compose-and-institute-keymap) | 168 | :set #'allout-compose-and-institute-keymap) |
| 169 | ;;;_ = allout-keybindings-binding | 169 | ;;;_ = allout-keybindings-binding |
diff --git a/lisp/auth-source.el b/lisp/auth-source.el index 1f233f9f60f..5f5629d9cfc 100644 --- a/lisp/auth-source.el +++ b/lisp/auth-source.el | |||
| @@ -1985,7 +1985,7 @@ entries for git.gnus.org: | |||
| 1985 | 1985 | ||
| 1986 | 1986 | ||
| 1987 | (defun auth-source--decode-octal-string (string) | 1987 | (defun auth-source--decode-octal-string (string) |
| 1988 | "Convert octal STRING to utf-8 string. E.g: \"a\134b\" to \"a\b\"." | 1988 | "Convert octal STRING to utf-8 string. E.g.: \"a\\134b\" to \"a\\b\"." |
| 1989 | (let ((list (string-to-list string)) | 1989 | (let ((list (string-to-list string)) |
| 1990 | (size (length string))) | 1990 | (size (length string))) |
| 1991 | (decode-coding-string | 1991 | (decode-coding-string |
diff --git a/lisp/ffap.el b/lisp/ffap.el index 3492dcbf17a..5383f743878 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el | |||
| @@ -1098,12 +1098,12 @@ Suppose the cursor is somewhere that might be near end of file, | |||
| 1098 | the guessing would position point before punctuation (like comma) | 1098 | the guessing would position point before punctuation (like comma) |
| 1099 | after the file extension: | 1099 | after the file extension: |
| 1100 | 1100 | ||
| 1101 | C:\temp\file.log, which contain .... | 1101 | C:\\temp\\file.log, which contain .... |
| 1102 | =============================== (before) | 1102 | =============================== (before) |
| 1103 | ---------------- (after) | 1103 | ---------------- (after) |
| 1104 | 1104 | ||
| 1105 | 1105 | ||
| 1106 | C:\temp\file.log on Windows or /tmp/file.log on Unix | 1106 | C:\\temp\\file.log on Windows or /tmp/file.log on Unix |
| 1107 | =============================== (before) | 1107 | =============================== (before) |
| 1108 | ---------------- (after) | 1108 | ---------------- (after) |
| 1109 | 1109 | ||
diff --git a/lisp/gnus/gnus-art.el b/lisp/gnus/gnus-art.el index c3c5eab7d89..9f313108089 100644 --- a/lisp/gnus/gnus-art.el +++ b/lisp/gnus/gnus-art.el | |||
| @@ -694,7 +694,7 @@ used as possible file names." | |||
| 694 | 694 | ||
| 695 | (defcustom gnus-page-delimiter "^\^L" | 695 | (defcustom gnus-page-delimiter "^\^L" |
| 696 | "Regexp describing what to use as article page delimiters. | 696 | "Regexp describing what to use as article page delimiters. |
| 697 | The default value is \"^\^L\", which is a form linefeed at the | 697 | The default value is \"^\\^L\", which is a form linefeed at the |
| 698 | beginning of a line." | 698 | beginning of a line." |
| 699 | :type 'regexp | 699 | :type 'regexp |
| 700 | :group 'gnus-article-various) | 700 | :group 'gnus-article-various) |
diff --git a/lisp/gnus/nnheader.el b/lisp/gnus/nnheader.el index 97821894b48..ea679759f3e 100644 --- a/lisp/gnus/nnheader.el +++ b/lisp/gnus/nnheader.el | |||
| @@ -1016,7 +1016,7 @@ See `find-file-noselect' for the arguments." | |||
| 1016 | (nnheader-skeleton-replace from to t)) | 1016 | (nnheader-skeleton-replace from to t)) |
| 1017 | 1017 | ||
| 1018 | (defun nnheader-strip-cr () | 1018 | (defun nnheader-strip-cr () |
| 1019 | "Strip all \r's from the current buffer." | 1019 | "Strip all \\r's from the current buffer." |
| 1020 | (nnheader-skeleton-replace "\r")) | 1020 | (nnheader-skeleton-replace "\r")) |
| 1021 | 1021 | ||
| 1022 | (define-obsolete-function-alias 'nnheader-cancel-timer 'cancel-timer "27.1") | 1022 | (define-obsolete-function-alias 'nnheader-cancel-timer 'cancel-timer "27.1") |
diff --git a/lisp/proced.el b/lisp/proced.el index 3435f1ab8cd..7d7de1e2ce3 100644 --- a/lisp/proced.el +++ b/lisp/proced.el | |||
| @@ -2261,7 +2261,7 @@ If LOG is a string and there are more args, it is formatted with | |||
| 2261 | those ARGS. Usually the LOG string ends with a \\n. | 2261 | those ARGS. Usually the LOG string ends with a \\n. |
| 2262 | End each bunch of errors with (proced-log t signal): | 2262 | End each bunch of errors with (proced-log t signal): |
| 2263 | this inserts the current time, buffer and signal at the start of the page, | 2263 | this inserts the current time, buffer and signal at the start of the page, |
| 2264 | and \f (formfeed) at the end." | 2264 | and \\f (formfeed) at the end." |
| 2265 | (let ((obuf (current-buffer))) | 2265 | (let ((obuf (current-buffer))) |
| 2266 | (with-current-buffer (get-buffer-create proced-log-buffer) | 2266 | (with-current-buffer (get-buffer-create proced-log-buffer) |
| 2267 | (goto-char (point-max)) | 2267 | (goto-char (point-max)) |
diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index 0f11103cf02..b5d91f46b17 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el | |||
| @@ -96,8 +96,8 @@ | |||
| 96 | 96 | ||
| 97 | (defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> " | 97 | (defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> " |
| 98 | "Regexp to match IDL prompt at beginning of a line. | 98 | "Regexp to match IDL prompt at beginning of a line. |
| 99 | For example, \"^\r?IDL> \" or \"^\r?WAVE> \". | 99 | For example, \"^\\r?IDL> \" or \"^\\r?WAVE> \". |
| 100 | The \"^\r?\" is needed, to indicate the beginning of the line, with | 100 | The \"^\\r?\" is needed, to indicate the beginning of the line, with |
| 101 | optional return character (which IDL seems to output randomly). | 101 | optional return character (which IDL seems to output randomly). |
| 102 | This variable is used to initialize `comint-prompt-regexp' in the | 102 | This variable is used to initialize `comint-prompt-regexp' in the |
| 103 | process buffer." | 103 | process buffer." |
diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el index d6a1d0eade8..184c1278072 100644 --- a/lisp/url/url-http.el +++ b/lisp/url/url-http.el | |||
| @@ -427,7 +427,7 @@ Use `url-http-referer' as the Referer-header (subject to `url-privacy-level')." | |||
| 427 | 427 | ||
| 428 | ;; Parsing routines | 428 | ;; Parsing routines |
| 429 | (defun url-http-clean-headers () | 429 | (defun url-http-clean-headers () |
| 430 | "Remove trailing \r from header lines. | 430 | "Remove trailing \\r from header lines. |
| 431 | This allows us to use `mail-fetch-field', etc. | 431 | This allows us to use `mail-fetch-field', etc. |
| 432 | Return the number of characters removed." | 432 | Return the number of characters removed." |
| 433 | (let ((end (marker-position url-http-end-of-headers))) | 433 | (let ((end (marker-position url-http-end-of-headers))) |
diff --git a/lisp/vcursor.el b/lisp/vcursor.el index ec5adbd832c..15791285b13 100644 --- a/lisp/vcursor.el +++ b/lisp/vcursor.el | |||
| @@ -433,7 +433,7 @@ Default is nil." | |||
| 433 | (defcustom vcursor-interpret-input nil | 433 | (defcustom vcursor-interpret-input nil |
| 434 | "If non-nil, input from the vcursor is treated as interactive input. | 434 | "If non-nil, input from the vcursor is treated as interactive input. |
| 435 | This will cause text insertion to be much slower. Note that no special | 435 | This will cause text insertion to be much slower. Note that no special |
| 436 | interpretation of strings is done: \"\C-x\" is a string of four | 436 | interpretation of strings is done: \"\\C-x\" is a string of four |
| 437 | characters. The default is simply to copy strings." | 437 | characters. The default is simply to copy strings." |
| 438 | :type 'boolean | 438 | :type 'boolean |
| 439 | :version "20.3") | 439 | :version "20.3") |