]> git.eshelyaron.com Git - emacs.git/commitdiff
Shorten over-wide docstrings in variables
authorStefan Kangas <stefan@marxist.se>
Sat, 19 Dec 2020 16:35:50 +0000 (17:35 +0100)
committerStefan Kangas <stefan@marxist.se>
Sat, 19 Dec 2020 17:21:06 +0000 (18:21 +0100)
* 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)

24 files changed:
lisp/cedet/semantic/util-modes.el
lisp/emacs-lisp/elint.el
lisp/erc/erc-dcc.el
lisp/expand.el
lisp/font-lock.el
lisp/gnus/gnus-sum.el
lisp/gnus/message.el
lisp/gnus/nnmh.el
lisp/gnus/nntp.el
lisp/international/mule-cmds.el
lisp/net/tramp.el
lisp/org/ob-R.el
lisp/org/org-attach.el
lisp/org/org.el
lisp/progmodes/elisp-mode.el
lisp/progmodes/ruby-mode.el
lisp/progmodes/verilog-mode.el
lisp/term.el
lisp/textmodes/table.el
lisp/vc/ediff-diff.el
lisp/vc/ediff-wind.el
lisp/vc/smerge-mode.el
lisp/vc/vc.el
lisp/view.el

index 776c6b1894ed0a4d8a61b37662b9a2c164c85876..8bfee432c3f62c9aafd6e4f340c47a746d4963b9 100644 (file)
@@ -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
index 79b72ff969f7260e057e72c8f556f2b59de50896..d0a0389b3b744c73dfa4de2392f33f6f60453709 100644 (file)
@@ -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."
index 1bce986a806d6db28e3fda72261e839745750abd..04508a44b6082295f4ec610d0a9043175fb34248 100644 (file)
@@ -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 <marker> :confirmed <marker>))
index 77e4fc2657c6149375be57592394b4cad798ccf7..c4e1d22790631d7843b5cef00ecb61fb7c68b09a 100644 (file)
@@ -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
index 0e771e8e0a541495ad344d5590227664f71eb520..a2cf71f9465ee08ac1f6fd023ed5038b7d80f720 100644 (file)
@@ -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)
index b8b055c02ce721edcc05d68a3b51fb4101e09c57..a0e7173998b62167eab77caf62ab7912404e8ceb 100644 (file)
@@ -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.")
index cf4020c874ca5a5cdbc67539901bb3fe15cba49c..86800f28cc4ff3a1ea0670125758029d3e2ddc93 100644 (file)
@@ -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)
index 581a408009dfea4dde35186e1889810ed2139a55..5584dad45f17637128498f1e454c26cb548c6402 100644 (file)
@@ -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.")
index a5c824479269856944e3b0502193a35b84a1f635..887dce3472f732020d5a74a8c753ce7045297f23 100644 (file)
@@ -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.")
index d59f2c0ebfca4cd428b46a3682a1d9b74ce5d316..e61c66e3328f5d1fc77a6b853647072374fe8000 100644 (file)
@@ -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)
index 30818fe7e64c28deaf76714e53b27324f9a0b08e..6c1c09bc37133bc6a6baf8171d1d9b023bfc5f8e 100644 (file)
@@ -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,
index 5e9d35f58e2d2677a4d81928f8ab80e4e9ade4d2..b4cf360730d1b7dfd2fc898a1bded4079f3de102 100644 (file)
@@ -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\"
index e6aa97e0080e75eb8e7407bfd3313768dbbff151..9360562b0952ee421914250d6fd63ef04c6afcfe 100644 (file)
@@ -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'.
index 1f7e434cefdba94114c27a920970f7a0e07ad5b4..0d7c6c87fdc21199a70ceef342a5ad90bc145e90 100644 (file)
@@ -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.")
 
index b7e0c4522885946dab597ab85fa907cc179b5fdc..0e5155308528c64a52c953e0016437dc2132fc1e 100644 (file)
@@ -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
index fbc6e424eb1118db373a5c6cb8cb2eab4b660520..8cb0350dc0645d88f856216d6ef8497eabbb424f 100644 (file)
@@ -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")
index b1abefe534e0449bc45c0d3c170806e76f71d973..f6e95b9cb6a27dab75703b9af4da4ff69fee78fd 100644 (file)
@@ -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)...
index 2e69af0735b41c5cdf0191c52ffa7ca952901c71..d73a9b0d01c6fc1fc400e7231b31a9ac8d44d5d8 100644 (file)
@@ -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)
index e42615e51581676017018bc601b5a5a7d1b9d7c4..59d60272aa89c6b3f1d5fcc0793445f407eacc67 100644 (file)
@@ -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'.
index ccf5a7807f2ea1fb99deb4d9379b3f7ea6b21640..adb6ce8053710a7ce7436472dfe1cbdb8d9e71c7 100644 (file)
@@ -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")
 
index c68dc71884306e87fb9c7f8ab47721f6dbc0bc57..3d90ccb1cbb7c7bdc86d3f8c3957cdb8a01e575d 100644 (file)
@@ -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.
index 13f875b1920d4c9190fd61f712a1b0475601e74e..5c41761a04badc7491ec65056b477a8ebe3bdfc3 100644 (file)
@@ -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.
index 7d9af00de7c3295457a07d0fe2bb2d0b66072ab5..160016c3e5e69268dec88f93f60de54dd09054fa 100644 (file)
@@ -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)
index 6f576f8c046d3e54812301067f75929c965793df..c1b788a739387dfc8fd40b2da4e686d9059fdcbe 100644 (file)
@@ -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