From f88a7897a80ee9129bdc444cafff32d026c4b6d8 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sat, 19 Dec 2020 17:35:50 +0100 Subject: [PATCH] Shorten over-wide docstrings in variables * lisp/cedet/semantic/util-modes.el (semantic-highlight-func-popup-menu): * lisp/emacs-lisp/elint.el (elint-top-form-logged): * lisp/erc/erc-dcc.el (erc-dcc-list): * lisp/expand.el (expand-pos): * lisp/font-lock.el (cpp-font-lock-keywords-source-depth): * lisp/gnus/gnus-sum.el (gnus-sort-gathered-threads-function): * lisp/gnus/message.el (message-cite-style-thunderbird): * lisp/gnus/nnmh.el (nnmh-be-safe): * lisp/gnus/nntp.el (nntp-open-telnet-envuser): * lisp/international/mule-cmds.el (current-transient-input-method): * lisp/net/tramp.el (tramp-file-name-structure): * lisp/org/ob-R.el (org-babel-R-write-object-command): * lisp/org/org-attach.el (org-attach-after-change-hook): * lisp/org/org.el (org-stamp-time-of-day-regexp): * lisp/progmodes/elisp-mode.el (elisp-xref-find-def-functions): * lisp/progmodes/ruby-mode.el (ruby-block-mid-re): * lisp/progmodes/verilog-mode.el (verilog-cache-enabled): * lisp/term.el (term-scroll-end): * lisp/textmodes/table.el (table-command-remap-alist) (table-inhibit-auto-fill-paragraph, table-command-remap-alist): * lisp/vc/ediff-diff.el (ediff-ignore-similar-regions): * lisp/vc/ediff-wind.el (ediff-mouse-pixel-threshold): * lisp/vc/smerge-mode.el (smerge-refine-ignore-whitespace): * lisp/vc/vc.el (vc-log-short-style): * lisp/view.el (view-exit-action): Shorten doc strings to not exceed 80-column limits. (Bug#44858) --- lisp/cedet/semantic/util-modes.el | 3 ++- lisp/emacs-lisp/elint.el | 2 +- lisp/erc/erc-dcc.el | 3 ++- lisp/expand.el | 2 +- lisp/font-lock.el | 4 ++-- lisp/gnus/gnus-sum.el | 6 +++--- lisp/gnus/message.el | 3 ++- lisp/gnus/nnmh.el | 2 +- lisp/gnus/nntp.el | 3 ++- lisp/international/mule-cmds.el | 2 +- lisp/net/tramp.el | 4 ++-- lisp/org/ob-R.el | 2 +- lisp/org/org-attach.el | 2 +- lisp/org/org.el | 3 ++- lisp/progmodes/elisp-mode.el | 2 +- lisp/progmodes/ruby-mode.el | 2 +- lisp/progmodes/verilog-mode.el | 3 ++- lisp/term.el | 4 ++-- lisp/textmodes/table.el | 8 +++++--- lisp/vc/ediff-diff.el | 2 +- lisp/vc/ediff-wind.el | 2 +- lisp/vc/smerge-mode.el | 2 +- lisp/vc/vc.el | 5 +++-- lisp/view.el | 3 ++- 24 files changed, 42 insertions(+), 32 deletions(-) diff --git a/lisp/cedet/semantic/util-modes.el b/lisp/cedet/semantic/util-modes.el index 776c6b1894e..8bfee432c3f 100644 --- a/lisp/cedet/semantic/util-modes.el +++ b/lisp/cedet/semantic/util-modes.el @@ -837,7 +837,8 @@ Argument EVENT describes the event that caused this function to be called." "Keymap for highlight-func minor mode.") (defvar semantic-highlight-func-popup-menu nil - "Menu used if the user clicks on the header line used by `semantic-highlight-func-mode'.") + "Menu used if the user clicks on the header line. +Used by `semantic-highlight-func-mode'.") (easy-menu-define semantic-highlight-func-popup-menu diff --git a/lisp/emacs-lisp/elint.el b/lisp/emacs-lisp/elint.el index 79b72ff969f..d0a0389b3b7 100644 --- a/lisp/emacs-lisp/elint.el +++ b/lisp/emacs-lisp/elint.el @@ -521,7 +521,7 @@ Return nil if there are no more forms, t otherwise." "The currently linted top form, or nil.") (defvar elint-top-form-logged nil - "The value t if the currently linted top form has been mentioned in the log buffer.") + "Non-nil if the currently linted top form has been mentioned in the log buffer.") (defun elint-top-form (form) "Lint a top FORM." diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index 1bce986a806..04508a44b60 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -83,7 +83,8 @@ All values of the list must be uppercase strings.") (defvar erc-dcc-list nil "List of DCC connections. Looks like: - ((:nick \"nick!user@host\" :type GET :peer proc :parent proc :size size :file file) + ((:nick \"nick!user@host\" :type GET :peer proc + :parent proc :size size :file file) (:nick \"nick!user@host\" :type CHAT :peer proc :parent proc) (:nick \"nick\" :type SEND :peer server-proc :parent parent-proc :file file :sent :confirmed )) diff --git a/lisp/expand.el b/lisp/expand.el index 77e4fc2657c..c4e1d227906 100644 --- a/lisp/expand.el +++ b/lisp/expand.el @@ -290,7 +290,7 @@ If ARG is omitted, point is placed at the end of the expanded text." (defvar expand-list nil "Temporary variable used by the Expand package.") (defvar expand-pos nil - "If non-nil, stores a vector containing markers to positions defined by the last expansion.") + "If non-nil, store a vector with position markers defined by the last expansion.") (make-variable-buffer-local 'expand-pos) (defvar expand-index 0 diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 0e771e8e0a5..a2cf71f9465 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -2280,8 +2280,8 @@ This function could be MATCHER in a MATCH-ANCHORED `font-lock-keywords' item." ;; "ifndef" "import" "include" "line" "pragma" "undef" "warning"))) ;; (defconst cpp-font-lock-keywords-source-depth 0 - "An integer representing regular expression depth of `cpp-font-lock-keywords-source-directives'. -Used in `cpp-font-lock-keywords'.") + "Regular expression depth of `cpp-font-lock-keywords-source-directives'. +This should be an integer. Used in `cpp-font-lock-keywords'.") (defconst cpp-font-lock-keywords (let* ((directives cpp-font-lock-keywords-source-directives) diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index b8b055c02ce..a0e7173998b 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -1400,7 +1400,7 @@ the normal Gnus MIME machinery." (defvar gnus-thread-indent-array nil) (defvar gnus-thread-indent-array-level gnus-thread-indent-level) (defvar gnus-sort-gathered-threads-function #'gnus-thread-sort-by-number - "Function called to sort the articles within a thread after it has been gathered together.") + "Function to sort articles within a thread after it has been gathered together.") (defvar gnus-summary-save-parts-type-history nil) (defvar gnus-summary-save-parts-last-directory mm-default-directory) @@ -1526,7 +1526,7 @@ the type of the variable (string, integer, character, etc).") "Default shell command on article.") (defvar gnus-newsgroup-agentized nil - "Locally bound in each summary buffer to indicate whether the server has been agentized.") + "Locally bound in each summary buffer to indicate if server has been agentized.") (defvar gnus-newsgroup-begin nil) (defvar gnus-newsgroup-end nil) (defvar gnus-newsgroup-last-rmail nil) @@ -1556,7 +1556,7 @@ the type of the variable (string, integer, character, etc).") (defvar gnus-newsgroup-expunged-tally nil) (defvar gnus-newsgroup-marked nil - "Sorted list of ticked articles in the current newsgroup (a subset of unread art).") + "Sorted list of ticked articles in current newsgroup (a subset of unread art).") (defvar gnus-newsgroup-spam-marked nil "List of ranges of articles that have been marked as spam.") diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index cf4020c874c..86800f28cc4 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -1200,7 +1200,8 @@ use in `gnus-posting-styles', such as: (message-yank-cited-prefix ">") (message-yank-empty-prefix ">") (message-citation-line-format "On %D %R %p, %N wrote:")) - "Message citation style used by Mozilla Thunderbird. Use with `message-cite-style'.") + "Message citation style used by Mozilla Thunderbird. +Use with `message-cite-style'.") (defconst message-cite-style-gmail '((message-cite-function 'message-cite-original) diff --git a/lisp/gnus/nnmh.el b/lisp/gnus/nnmh.el index 581a408009d..5584dad45f1 100644 --- a/lisp/gnus/nnmh.el +++ b/lisp/gnus/nnmh.el @@ -46,7 +46,7 @@ "Hook run narrowed to an article before saving.") (defvoo nnmh-be-safe nil - "If non-nil, nnmh will check all articles to make sure whether they are new or not. + "If non-nil, nnmh will check all articles to make sure if they are new or not. Go through the .nnmh-articles file and compare with the actual articles in this folder. The articles that are \"new\" will be marked as unread by Gnus.") diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el index a5c82447926..887dce3472f 100644 --- a/lisp/gnus/nntp.el +++ b/lisp/gnus/nntp.el @@ -1751,7 +1751,8 @@ If SEND-IF-FORCE, only send authinfo to the server if the ;; ========================================================================== (defvoo nntp-open-telnet-envuser nil - "If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.") + "If non-nil, telnet session supports the ENVIRON option. +Don't prompt for login name. This applies to both client and server.") (defvoo nntp-telnet-shell-prompt "bash\\|[$>] *\r?$" "Regular expression to match the shell prompt on the remote machine.") diff --git a/lisp/international/mule-cmds.el b/lisp/international/mule-cmds.el index d59f2c0ebfc..e61c66e3328 100644 --- a/lisp/international/mule-cmds.el +++ b/lisp/international/mule-cmds.el @@ -1356,7 +1356,7 @@ This is the input method activated by the command :version "28.1") (defvar current-transient-input-method nil - "The current input method temporarily enabled by `activate-transient-input-method'. + "Current input method temporarily enabled by `activate-transient-input-method'. If nil, that means no transient input method is active now.") (make-variable-buffer-local 'current-transient-input-method) (put 'current-transient-input-method 'permanent-local t) diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 30818fe7e64..6c1c09bc371 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -1022,8 +1022,8 @@ See `tramp-file-name-structure'." 5 6 7 8 1)) (defvar tramp-file-name-structure nil ;Initialized when defining `tramp-syntax'! - "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \ -the Tramp file name structure. + "List detailing the Tramp file name structure. +This is a list of six elements (REGEXP METHOD USER HOST FILE HOP). The first element REGEXP is a regular expression matching a Tramp file name. The regex should contain parentheses around the method name, diff --git a/lisp/org/ob-R.el b/lisp/org/ob-R.el index 5e9d35f58e2..b4cf360730d 100644 --- a/lisp/org/ob-R.el +++ b/lisp/org/ob-R.el @@ -361,7 +361,7 @@ Each member of this list is a list with three members: ) } }(object=%s,transfer.file=\"%s\")" - "A template for an R command to evaluate a block of code and write the result to a file. + "Template for an R command to evaluate a block of code and write result to file. Has four %s escapes to be filled in: 1. Row names, \"TRUE\" or \"FALSE\" diff --git a/lisp/org/org-attach.el b/lisp/org/org-attach.el index e6aa97e0080..9360562b095 100644 --- a/lisp/org/org-attach.el +++ b/lisp/org/org-attach.el @@ -182,7 +182,7 @@ attachment folders based on ID." :type '(repeat (function :tag "Function with ID as input"))) (defvar org-attach-after-change-hook nil - "Hook to be called when files have been added or removed to the attachment folder.") + "Hook called when files have been added or removed to the attachment folder.") (defvar org-attach-open-hook nil "Hook that is invoked by `org-attach-open'. diff --git a/lisp/org/org.el b/lisp/org/org.el index 1f7e434cefd..0d7c6c87fdc 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -4112,7 +4112,8 @@ groups carry important information: "Regular expression to match a timestamp time or time range. After a match, the following groups carry important information: 0 the full match -1 date plus weekday, for back referencing to make sure both times are on the same day +1 date plus weekday, for back referencing to make sure + both times are on the same day 2 the first time, range or not 4 the second time, if it is a range.") diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index b7e0c452288..0e515530852 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -682,7 +682,7 @@ otherwise build the summary from TYPE and SYMBOL." (xref-make-elisp-location symbol type file))) (defvar elisp-xref-find-def-functions nil - "List of functions to be run from `elisp--xref-find-definitions' to add additional xrefs. + "List of functions run from `elisp--xref-find-definitions' to add more xrefs. Called with one arg; the symbol whose definition is desired. Each function should return a list of xrefs, or nil; the first non-nil result supersedes the xrefs produced by diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el index fbc6e424eb1..8cb0350dc06 100644 --- a/lisp/progmodes/ruby-mode.el +++ b/lisp/progmodes/ruby-mode.el @@ -75,7 +75,7 @@ (defconst ruby-block-mid-re (regexp-opt ruby-block-mid-keywords) - "Regexp to match where the indentation gets shallower in middle of block statements.") + "Regexp for where the indentation gets shallower in middle of block statements.") (defconst ruby-block-op-keywords '("and" "or" "not") diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index b1abefe534e..f6e95b9cb6a 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -10112,7 +10112,8 @@ variables to build the path." ;; A modi is: [module-name-string file-name begin-point] (defvar verilog-cache-enabled t - "Non-nil enables caching of signals, etc. Set to nil for debugging to make things SLOW!") + "Non-nil enables caching of signals, etc. +Set to nil for debugging to make things SLOW!") (defvar verilog-modi-cache-list nil "Cache of ((Module Function) Buf-Tick Buf-Modtime Func-Returns)... diff --git a/lisp/term.el b/lisp/term.el index 2e69af0735b..d73a9b0d01c 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -365,8 +365,8 @@ not allowed.") (defvar-local term-scroll-end nil "Bottom-most line (inclusive) of the scrolling region. `term-scroll-end' must be in the range [0,term-height). In addition, its -value has to be greater than `term-scroll-start', i.e. one line scroll regions are -not allowed.") +value has to be greater than `term-scroll-start', i.e. one line scroll regions +are not allowed.") (defvar term-pager-count nil "Number of lines before we need to page; if nil, paging is disabled.") (defvar term-saved-cursor nil) diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el index e42615e5158..59d60272aa8 100644 --- a/lisp/textmodes/table.el +++ b/lisp/textmodes/table.el @@ -853,10 +853,12 @@ simply by any key input." "Timer id for deferred cell update.") (defvar table-inhibit-update nil "Non-nil inhibits implicit cell and cache updates. -It inhibits `table-with-cache-buffer' to update data in both direction, cell to cache and cache to cell.") +It inhibits `table-with-cache-buffer' to update data in both directions, +cell to cache and cache to cell.") (defvar table-inhibit-auto-fill-paragraph nil "Non-nil inhibits auto fill paragraph when `table-with-cache-buffer' exits. -This is always set to nil at the entry to `table-with-cache-buffer' before executing body forms.") +This is always set to nil at the entry to `table-with-cache-buffer' before +executing body forms.") (defvar table-mode-indicator nil "For mode line indicator") ;; This is not a real minor-mode but placed in the minor-mode-alist @@ -957,7 +959,7 @@ This is always set to nil at the entry to `table-with-cache-buffer' before execu (describe-bindings . *table--cell-describe-bindings) (dabbrev-expand . *table--cell-dabbrev-expand) (dabbrev-completion . *table--cell-dabbrev-completion)) - "List of cons cells consisting of (ORIGINAL-COMMAND . TABLE-VERSION-OF-THE-COMMAND).") + "List of the form (ORIGINAL-COMMAND . TABLE-VERSION-OF-THE-COMMAND).") (defvar table-command-list ;; Construct the real contents of the `table-command-list'. diff --git a/lisp/vc/ediff-diff.el b/lisp/vc/ediff-diff.el index ccf5a7807f2..adb6ce80537 100644 --- a/lisp/vc/ediff-diff.el +++ b/lisp/vc/ediff-diff.el @@ -149,7 +149,7 @@ This variable can be set either in .emacs or toggled interactively. Use `setq-default' if setting it in .emacs") (ediff-defvar-local ediff-ignore-similar-regions nil - "If t, skip over difference regions that differ only in the white space and line breaks. + "If t, skip difference regions that differ only in white space and line breaks. This variable can be set either in .emacs or toggled interactively. Use `setq-default' if setting it in .emacs") diff --git a/lisp/vc/ediff-wind.el b/lisp/vc/ediff-wind.el index c68dc718843..3d90ccb1cbb 100644 --- a/lisp/vc/ediff-wind.el +++ b/lisp/vc/ediff-wind.el @@ -182,7 +182,7 @@ Used internally---not a user option.") ;; not used for now (defvar ediff-mouse-pixel-threshold 30 - "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.") + "If mouse moved more than this many pixels, don't warp mouse into control window.") (defcustom ediff-grab-mouse t "If t, Ediff will always grab the mouse and put it in the control frame. diff --git a/lisp/vc/smerge-mode.el b/lisp/vc/smerge-mode.el index 13f875b1920..5c41761a04b 100644 --- a/lisp/vc/smerge-mode.el +++ b/lisp/vc/smerge-mode.el @@ -925,7 +925,7 @@ Its behavior has mainly two restrictions: This only matters if `smerge-refine-weight-hack' is nil.") (defvar smerge-refine-ignore-whitespace t - "If non-nil, indicate that `smerge-refine' should try to ignore change in whitespace.") + "If non-nil, `smerge-refine' should try to ignore change in whitespace.") (defvar smerge-refine-weight-hack t "If non-nil, pass to diff as many lines as there are chars in the region. diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 7d9af00de7c..160016c3e5e 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -2386,8 +2386,9 @@ This function runs the hook `vc-retrieve-tag-hook' when finished." ;; for the root directory. (defvar vc-log-short-style '(directory) "Whether or not to show a short log. -If it contains `directory' then if the fileset contains a directory show a short log. -If it contains `file' then show short logs for files. +If it contains `directory', show a short log if the fileset +contains a directory. +If it contains `file', show short logs for files. Not all VC backends support short logs!") (defvar log-view-vc-fileset) diff --git a/lisp/view.el b/lisp/view.el index 6f576f8c046..c1b788a7393 100644 --- a/lisp/view.el +++ b/lisp/view.el @@ -141,7 +141,8 @@ See RETURN-TO-ALIST argument of function `view-mode-exit' for the format of (put 'view-return-to-alist 'permanent-local t) (defvar view-exit-action nil - "If non-nil, a function with one argument (a buffer) called when finished viewing. + "If non-nil, a function called when finished viewing. +The function should take one argument (a buffer). Commands like \\[view-file] and \\[view-file-other-window] may set this to bury or kill the viewed buffer. Observe that the buffer viewed might not appear in any window at -- 2.39.2