[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
scratch/bug-44858 2f59fad 1/6: ; Adjust overly long docstrings to fit 80
|
From: |
Stefan Kangas |
|
Subject: |
scratch/bug-44858 2f59fad 1/6: ; Adjust overly long docstrings to fit 80 characters |
|
Date: |
Fri, 24 Sep 2021 13:19:51 -0400 (EDT) |
branch: scratch/bug-44858
commit 2f59fade17fd1cce89817db289b9477930f50766
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
; Adjust overly long docstrings to fit 80 characters
---
lisp/array.el | 5 +++--
lisp/cedet/data-debug.el | 3 ++-
lisp/cedet/semantic/analyze/complete.el | 3 ++-
lisp/cedet/semantic/db-find.el | 2 +-
lisp/cedet/semantic/tag-ls.el | 19 ++++++++++++++-----
lisp/emacs-lisp/eieio-core.el | 2 +-
lisp/emacs-lisp/seq.el | 4 ++--
lisp/emulation/viper-cmd.el | 3 ++-
lisp/emulation/viper-init.el | 3 ++-
lisp/erc/erc-backend.el | 3 ++-
lisp/erc/erc-dcc.el | 5 ++---
lisp/frameset.el | 3 ++-
lisp/gnus/gnus-agent.el | 4 ++--
lisp/gnus/gnus-bookmark.el | 4 +++-
lisp/gnus/gnus-fun.el | 3 ++-
lisp/gnus/gnus-group.el | 6 ++++--
lisp/gnus/gnus-score.el | 4 +++-
lisp/gnus/gnus-sum.el | 9 +++++----
lisp/gnus/nnvirtual.el | 8 +++++---
lisp/net/dbus.el | 3 ++-
lisp/net/dictionary.el | 2 +-
lisp/net/eudc.el | 5 +++--
lisp/net/ntlm.el | 4 ++--
lisp/net/tramp-gvfs.el | 11 +++++++----
lisp/net/tramp-sh.el | 2 +-
lisp/org/ob-table.el | 3 ++-
lisp/org/org-agenda.el | 3 ++-
lisp/org/org-protocol.el | 15 ++++++++-------
lisp/play/doctor.el | 4 ++--
lisp/progmodes/cc-cmds.el | 2 +-
lisp/progmodes/flymake-proc.el | 7 ++++---
lisp/progmodes/idlwave.el | 3 ++-
lisp/progmodes/prolog.el | 3 ++-
lisp/progmodes/verilog-mode.el | 14 ++++++++++----
lisp/tab-bar.el | 7 ++++---
lisp/textmodes/texinfo.el | 3 ++-
lisp/vc/ediff-merg.el | 3 ++-
lisp/vc/ediff.el | 10 ++++++----
lisp/vc/vc-annotate.el | 3 ++-
lisp/vc/vc-dir.el | 3 ++-
lisp/vc/vc-dispatcher.el | 2 +-
lisp/vc/vc.el | 4 ++--
lisp/whitespace.el | 4 ++--
test/lisp/auth-source-pass-tests.el | 6 ++++--
test/lisp/international/ucs-normalize-tests.el | 6 +++---
45 files changed, 138 insertions(+), 87 deletions(-)
diff --git a/lisp/array.el b/lisp/array.el
index 6632da5..2c9a681 100644
--- a/lisp/array.el
+++ b/lisp/array.el
@@ -805,8 +805,9 @@ NOT recognized as integers or real numbers.
The array MUST reside at the top of the buffer.
TABs are not respected, and may be converted into spaces at any time.
-Setting the variable `array-respect-tabs' to non-nil will prevent TAB
conversion,
-but will cause many functions to give errors if they encounter one.
+Setting the variable `array-respect-tabs' to non-nil will prevent
+TAB conversion, but will cause many functions to give errors if
+they encounter one.
Upon entering array mode, you will be prompted for the values of
several variables. Others will be calculated based on the values you
diff --git a/lisp/cedet/data-debug.el b/lisp/cedet/data-debug.el
index 428848b..8f40a4d 100644
--- a/lisp/cedet/data-debug.el
+++ b/lisp/cedet/data-debug.el
@@ -413,7 +413,8 @@ PREBUTTONTEXT is some text between prefix and the stuff
list button."
)
(defun data-debug-insert-hash-table-button (hash-table prefix prebuttontext)
- "Insert HASH-TABLE as expandable button with recursive prefix PREFIX and
PREBUTTONTEXT in front of the button text."
+ "Insert HASH-TABLE as expandable button with recursive prefix PREFIX and
+PREBUTTONTEXT in front of the button text."
(let ((string (propertize (format "%s" hash-table)
'face 'font-lock-keyword-face)))
(insert (propertize
diff --git a/lisp/cedet/semantic/analyze/complete.el
b/lisp/cedet/semantic/analyze/complete.el
index 1e8cd9a..5c3228a 100644
--- a/lisp/cedet/semantic/analyze/complete.el
+++ b/lisp/cedet/semantic/analyze/complete.el
@@ -70,7 +70,8 @@ context. Passing in a context is useful if the caller also
needs
to access parts of the analysis.
The remaining FLAGS arguments are passed to the mode specific completion
engine.
Bad flags should be ignored by modes that don't use them.
-See `semantic-analyze-possible-completions-default' for details on the default
FLAGS.
+See `semantic-analyze-possible-completions-default' for details
+on the default FLAGS.
Completions run through the following filters:
* Elements currently in scope
diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el
index 61baaa0..e6a7879 100644
--- a/lisp/cedet/semantic/db-find.el
+++ b/lisp/cedet/semantic/db-find.el
@@ -914,7 +914,7 @@ but should be good enough for debugging assertions."
(null (car (cdr (car resultp)))))))
(defun semanticdb-find-result-prin1-to-string (result)
- "Presuming RESULT satisfies `semanticdb-find-results-p', provide a short
PRIN1 output."
+ "If RESULT satisfies `semanticdb-find-results-p', provide a short PRIN1
output."
(if (< (length result) 2)
(concat "#<FIND RESULT "
(mapconcat (lambda (a)
diff --git a/lisp/cedet/semantic/tag-ls.el b/lisp/cedet/semantic/tag-ls.el
index 3aa1a62..4bdae58 100644
--- a/lisp/cedet/semantic/tag-ls.el
+++ b/lisp/cedet/semantic/tag-ls.el
@@ -130,7 +130,10 @@ are the same.
Similar tags that have sub-tags such as arg lists or type members,
are similar w/out checking the sub-list of tags.
-Optional argument IGNORABLE-ATTRIBUTES are attributes to ignore while
comparing similarity.
+
+Optional argument IGNORABLE-ATTRIBUTES are attributes to ignore while comparing
+similarity.
+
By default, `semantic-tag-similar-ignorable-attributes' is referenced for
attributes, and IGNORABLE-ATTRIBUTES will augment this list.
@@ -191,11 +194,14 @@ See `semantic-tag-similar-p' for details."
;; will contain the info needed to determine the full name.
(define-overloadable-function semantic-tag-full-package (tag &optional
stream-or-buffer)
"Return the fully qualified package name of TAG in a package hierarchy.
-STREAM-OR-BUFFER can be anything convertible by
`semantic-something-to-tag-table',
-but must be a toplevel semantic tag stream that contains TAG.
+STREAM-OR-BUFFER can be anything convertible by
+`semantic-something-to-tag-table', but must be a toplevel
+semantic tag stream that contains TAG.
+
A Package Hierarchy is defined in UML by the way classes and methods
are organized on disk. Some languages use this concept such that a
class can be accessed via it's fully qualified name, (such as Java.)
+
Other languages qualify names within a Namespace (such as C++) which
result in a different package like structure.
@@ -214,11 +220,14 @@ Return the name of the first tag of class `package' in
STREAM."
(define-overloadable-function semantic-tag-full-name (tag &optional
stream-or-buffer)
"Return the fully qualified name of TAG in the package hierarchy.
-STREAM-OR-BUFFER can be anything convertible by
`semantic-something-to-tag-table',
-but must be a toplevel semantic tag stream that contains TAG.
+STREAM-OR-BUFFER can be anything convertible by
+`semantic-something-to-tag-table', but must be a toplevel
+semantic tag stream that contains TAG.
+
A Package Hierarchy is defined in UML by the way classes and methods
are organized on disk. Some languages use this concept such that a
class can be accessed via it's fully qualified name, (such as Java.)
+
Other languages qualify names within a Namespace (such as C++) which
result in a different package like structure.
diff --git a/lisp/emacs-lisp/eieio-core.el b/lisp/emacs-lisp/eieio-core.el
index b11ed33..80d1711 100644
--- a/lisp/emacs-lisp/eieio-core.el
+++ b/lisp/emacs-lisp/eieio-core.el
@@ -953,7 +953,7 @@ need be... May remove that later...)"
class))
(defun eieio--c3-merge-lists (reversed-partial-result remaining-inputs)
- "Merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order, if
possible.
+ "Try to merge REVERSED-PARTIAL-RESULT REMAINING-INPUTS in a consistent order.
If a consistent order does not exist, signal an error."
(setq remaining-inputs (delq nil remaining-inputs))
(if (null remaining-inputs)
diff --git a/lisp/emacs-lisp/seq.el b/lisp/emacs-lisp/seq.el
index ae59882..3fc63b7 100644
--- a/lisp/emacs-lisp/seq.el
+++ b/lisp/emacs-lisp/seq.el
@@ -529,7 +529,7 @@ SEQUENCE must be a sequence of numbers or markers."
(apply #'max (seq-into sequence 'list)))
(defun seq--count-successive (pred sequence)
- "Return the number of successive elements for which (PRED element) is
non-nil in SEQUENCE."
+ "Count successive elements for which (PRED element) is non-nil in SEQUENCE."
(let ((n 0)
(len (seq-length sequence)))
(while (and (< n len)
@@ -538,7 +538,7 @@ SEQUENCE must be a sequence of numbers or markers."
n))
(defun seq--make-pcase-bindings (args)
- "Return a list of bindings of the variables in ARGS to the elements of a
sequence."
+ "Return list of bindings of the variables in ARGS to the elements of a
sequence."
(let ((bindings '())
(index 0)
(rest-marker nil))
diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el
index c3b36f1..b132d78 100644
--- a/lisp/emulation/viper-cmd.el
+++ b/lisp/emulation/viper-cmd.el
@@ -3546,7 +3546,8 @@ If MODE is set, set the macros only in that major mode."
(defun viper-set-parsing-style-toggling-macro (unset)
- "Set `%%%' to be a macro that toggles whether comment fields should be
parsed for matching parentheses.
+ "Set `%%%' to be a macro that toggles whether comment fields should be parsed
+for matching parentheses.
This is used in conjunction with the `%' command.
With a prefix argument, unsets the macro."
diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el
index 730ca0b..ffcb460 100644
--- a/lisp/emulation/viper-init.el
+++ b/lisp/emulation/viper-init.el
@@ -932,7 +932,8 @@ Should be set in `viper-custom-file-name'."
(setq cursor-type '(bar . 2)))
(defun viper-ESC-keyseq-timeout ()
- "Key sequence beginning with ESC and separated by no more than this many
milliseconds is considered to be generated by a keyboard function key.
+ "Key sequence beginning with ESC and separated by no more than this many
+milliseconds is considered to be generated by a keyboard function key.
Setting this too high may slow down switching from insert to vi state. Setting
this value too low will make it impossible to use function keys in insert mode
on a dumb terminal."
diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el
index 10be296..140755f 100644
--- a/lisp/erc/erc-backend.el
+++ b/lisp/erc/erc-backend.el
@@ -1532,7 +1532,8 @@ add things to `%s' instead."
'WALLOPS ?n nick ?m message))))
(define-erc-response-handler (001)
- "Set `erc-server-current-nick' to reflect server settings and display the
welcome message."
+ "Set `erc-server-current-nick' to reflect server settings.
+Then display the welcome message."
nil
(erc-set-current-nick (car (erc-response.command-args parsed)))
(erc-update-mode-line) ; needed here?
diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el
index 147b902..db278a1 100644
--- a/lisp/erc/erc-dcc.el
+++ b/lisp/erc/erc-dcc.el
@@ -164,9 +164,8 @@ Looks like:
;;; Misc macros and utility functions
(defun erc-dcc-member (&rest args)
- "Return first matching entry in `erc-dcc-list' satisfying constraints in
plist ARGS.
-
-Return nil on no match.
+ "Return first matching entry in `erc-dcc-list' satisfying constraints in
ARGS.
+ARGS is a plist. Return nil on no match.
The property :nick is treated specially, if it contains a `!' character,
it is treated as a nick!user@host string, and compared with the :nick property
diff --git a/lisp/frameset.el b/lisp/frameset.el
index cdbac0a..998f4fb 100644
--- a/lisp/frameset.el
+++ b/lisp/frameset.el
@@ -1178,7 +1178,8 @@ FORCE-ONSCREEN can be:
- a list (LEFT TOP WIDTH HEIGHT), describing the workarea.
It must return non-nil to force the frame onscreen, nil otherwise.
-CLEANUP-FRAMES allows \"cleaning up\" the frame list after restoring a
frameset:
+CLEANUP-FRAMES allows \"cleaning up\" the frame list after
+restoring a frameset:
t Delete all frames that were not created or restored upon.
nil Keep all frames.
FUNC A function called with two arguments:
diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el
index 961965d..19d0512 100644
--- a/lisp/gnus/gnus-agent.el
+++ b/lisp/gnus/gnus-agent.el
@@ -1323,7 +1323,7 @@ downloaded into the agent."
(gnus-agent-set-local group agent-min (1- active-min)))))))
(defun gnus-agent-save-group-info (method group active)
- "Update a single group's active range in the agent's copy of the server's
active file."
+ "Update single group's active range in agent's copy of server's active file."
(when (gnus-agent-method-p method)
(let* ((gnus-command-method (or method gnus-command-method))
(coding-system-for-write nnheader-file-coding-system)
@@ -1356,7 +1356,7 @@ downloaded into the agent."
(delete-char 1)))))))
(defun gnus-agent-get-group-info (method group)
- "Get a single group's active range in the agent's copy of the server's
active file."
+ "Get single group's active range in agent's copy of server's active file."
(when (gnus-agent-method-p method)
(let* ((gnus-command-method (or method gnus-command-method))
(coding-system-for-write nnheader-file-coding-system)
diff --git a/lisp/gnus/gnus-bookmark.el b/lisp/gnus/gnus-bookmark.el
index 8c2a928..83e482f 100644
--- a/lisp/gnus/gnus-bookmark.el
+++ b/lisp/gnus/gnus-bookmark.el
@@ -198,7 +198,9 @@ So the cdr of each bookmark is an alist too.")
(defun gnus-bookmark-make-record
(group message-id author date subject annotation)
- "Return the record part of a new bookmark, given GROUP MESSAGE-ID AUTHOR
DATE SUBJECT and ANNOTATION."
+ "Return the record part of a new bookmark.
+Arguments GROUP MESSAGE-ID AUTHOR DATE SUBJECT and ANNOTATION
+will be saved in the bookmark."
(let ((the-record
`((group . ,(substring-no-properties group))
(message-id . ,(substring-no-properties message-id))
diff --git a/lisp/gnus/gnus-fun.el b/lisp/gnus/gnus-fun.el
index 8bca4ff..86b9536 100644
--- a/lisp/gnus/gnus-fun.el
+++ b/lisp/gnus/gnus-fun.el
@@ -97,7 +97,8 @@ PNG format."
;;;###autoload
(defun gnus--random-face-with-type (dir ext omit fun)
- "Return file from DIR with extension EXT, omitting matches of OMIT,
processed by FUN."
+ "Return file from DIR with extension EXT.
+Omit matches of OMIT, and process them by FUN."
(when (file-exists-p dir)
(let* ((files
(remove nil (mapcar
diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el
index 83c9535..8e6e3ff 100644
--- a/lisp/gnus/gnus-group.el
+++ b/lisp/gnus/gnus-group.el
@@ -4062,7 +4062,8 @@ of groups killed."
(if (< (length out) 2) (car out) (nreverse out))))
(defun gnus-group-yank-group (&optional arg)
- "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting
it before the current newsgroup.
+ "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it
+before the current newsgroup.
The numeric ARG specifies how many newsgroups are to be yanked. The
name of the newsgroup yanked is returned, or (if several groups are
yanked) a list of yanked groups is returned."
@@ -4716,7 +4717,8 @@ or `gnus-group-catchup-group-hook'."
(gnus-group-get-parameter group 'timestamp t))
(defun gnus-group-timestamp-delta (group)
- "Return the offset in seconds from the timestamp for GROUP to the current
time, as a floating point number."
+ "Return the offset in seconds from the timestamp for GROUP to the current
time.
+Return value is a floating point number."
;; FIXME: This should return a Lisp integer, not a Lisp float,
;; since it is always an integer.
(let* ((time (or (gnus-group-timestamp group) 0))
diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el
index 0626e8b..e0ad9f6 100644
--- a/lisp/gnus/gnus-score.el
+++ b/lisp/gnus/gnus-score.el
@@ -3115,7 +3115,9 @@ If ADAPT, return the home adaptive file instead."
;;;
(defun gnus-decay-score (score)
- "Decay SCORE according to `gnus-score-decay-constant' and
`gnus-score-decay-scale'."
+ "Decay SCORE according to decay variables.
+The decay variables are `gnus-score-decay-constant' and
+`gnus-score-decay-scale'."
(floor (- score
(* (if (< score 0) -1 1)
(min (abs score)
diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el
index 2ddd3d2..b3d0460 100644
--- a/lisp/gnus/gnus-sum.el
+++ b/lisp/gnus/gnus-sum.el
@@ -4357,7 +4357,8 @@ If SELECT-ARTICLES, only select those articles from
GROUP."
result))
(defun gnus-sort-gathered-threads (threads)
- "Sort subthreads inside each gathered thread by
`gnus-sort-gathered-threads-function'."
+ "Sort subthreads inside each gathered thread.
+Sorting is done by `gnus-sort-gathered-threads-function'."
(let ((result threads))
(while threads
(when (stringp (caar threads))
@@ -5173,7 +5174,7 @@ Unscored articles will be counted as having a score of
zero."
(gnus-article-sort-by-number h1 h2))
(defun gnus-thread-sort-by-most-recent-number (h1 h2)
- "Sort threads such that the thread with the most recently arrived article
comes first."
+ "Sort threads such that the thread with most recently arrived article is
first."
(> (gnus-thread-highest-number h1) (gnus-thread-highest-number h2)))
(defun gnus-thread-highest-number (thread)
@@ -5187,7 +5188,7 @@ Unscored articles will be counted as having a score of
zero."
(gnus-article-sort-by-date h1 h2))
(defun gnus-thread-sort-by-most-recent-date (h1 h2)
- "Sort threads such that the thread with the most recently dated article
comes first."
+ "Sort threads such that the thread with most recently dated article is
first."
(> (gnus-thread-latest-date h1) (gnus-thread-latest-date h2)))
(defsubst gnus-article-sort-by-newsgroups (h1 h2)
@@ -5651,7 +5652,7 @@ or a straight list of headers."
gnus-list-identifiers)))
(defun gnus-summary-remove-list-identifiers ()
- "Remove list identifiers in `gnus-list-identifiers' from articles in the
current group."
+ "Remove identifiers in `gnus-list-identifiers' from articles in current
group."
(let ((regexp (gnus-group-get-list-identifiers gnus-newsgroup-name))
changed subject)
(when regexp
diff --git a/lisp/gnus/nnvirtual.el b/lisp/gnus/nnvirtual.el
index 03a0ff2..4136392 100644
--- a/lisp/gnus/nnvirtual.el
+++ b/lisp/gnus/nnvirtual.el
@@ -382,7 +382,8 @@ It is computed from the marks of individual component
groups.")
(defun nnvirtual-update-xref-header (group article prefix sysname)
- "Edit current NOV header in current buffer to have an xref to the component
group, and also server prefix any existing xref lines."
+ "Edit current NOV header in current buffer to have an xref to the component
+group, and also server prefix any existing xref lines."
;; Move to beginning of Xref field, creating a slot if needed.
(beginning-of-line)
(looking-at
@@ -569,7 +570,8 @@ If UPDATE-P is not nil, call gnus-group-update-group on the
components."
;; unique reverse mapping.
(defun nnvirtual-map-article (article)
- "Return a cons of the component group and article corresponding to the given
virtual ARTICLE."
+ "Return a cons of the component group and article corresponding to the given
+virtual ARTICLE."
(let ((table nnvirtual-mapping-table)
entry group-pos)
(while (and table
@@ -590,7 +592,7 @@ If UPDATE-P is not nil, call gnus-group-update-group on the
components."
(defun nnvirtual-reverse-map-article (group article)
- "Return the virtual article number corresponding to the given component
GROUP and ARTICLE."
+ "Return virtual article number corresponding to component GROUP and ARTICLE."
(when (numberp article)
(let ((table nnvirtual-mapping-table)
(group-pos 0)
diff --git a/lisp/net/dbus.el b/lisp/net/dbus.el
index 4116d29..560ece6 100644
--- a/lisp/net/dbus.el
+++ b/lisp/net/dbus.el
@@ -2073,7 +2073,8 @@ either a method name, a signal name, or an error name."
(goto-char point)))
(defun dbus-monitor-handler (&rest _args)
- "Default handler for the \"org.freedesktop.DBus.Monitoring.BecomeMonitor\"
interface.
+ "Default handler for the \"Monitoring.BecomeMonitor\" interface.
+Its full name is \"org.freedesktop.DBus.Monitoring.BecomeMonitor\".
It will be applied for all objects created by `dbus-register-monitor'
which don't declare an own handler. The printed timestamps do
not reflect the time the D-Bus message has passed the D-Bus
diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el
index 85467cd..09d250f 100644
--- a/lisp/net/dictionary.el
+++ b/lisp/net/dictionary.el
@@ -1049,7 +1049,7 @@ If PATTERN is omitted, it defaults to \"[
\\f\\t\\n\\r\\v]+\"."
'dictionary-display-match-result)))
(defun dictionary-do-matching (word dictionary strategy function)
- "Find matches for WORD with STRATEGY in DICTIONARY and display them with
FUNCTION."
+ "Search for WORD with STRATEGY in DICTIONARY and display them with FUNCTION."
(message "Lookup matching words for %s in %s using %s"
word dictionary strategy)
(dictionary-send-command
diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el
index 5c451c6..14e5c28 100644
--- a/lisp/net/eudc.el
+++ b/lisp/net/eudc.el
@@ -798,8 +798,9 @@ see `eudc-inline-expansion-servers'."
"Query the directory server, and return the matching responses.
The variable `eudc-inline-query-format' controls how to associate the
individual QUERY-WORDS with directory attribute names.
-After querying the server for the given string, the expansion specified by
-`eudc-inline-expansion-format' is applied to the matches before returning
them.inserted in the buffer at point.
+After querying the server for the given string, the expansion
+specified by `eudc-inline-expansion-format' is applied to the
+matches before returning them.inserted in the buffer at point.
Multiple servers can be tried with the same query until one finds a match,
see `eudc-inline-expansion-servers'."
(cond
diff --git a/lisp/net/ntlm.el b/lisp/net/ntlm.el
index 747a69f..0e0146d 100644
--- a/lisp/net/ntlm.el
+++ b/lisp/net/ntlm.el
@@ -436,7 +436,7 @@ PASSWD is truncated to 14 bytes if longer."
(make-string (- 15 len) 0)))))
(defun ntlm-smb-owf-encrypt (passwd c8)
- "Return response string of 24 bytes long for password string PASSWD based on
DES encryption.
+ "Return response string of 24 bytes long for PASSWD based on DES encryption.
PASSWD is of at most 14 bytes long and the challenge string C8 of
8 bytes long."
(let* ((len (min (length passwd) 16))
@@ -459,7 +459,7 @@ PASSWD is of at most 14 bytes long and the challenge string
C8 of
(substring p15 7) t)))
(defun ntlm-smb-hash (in key forw)
- "Return hash string of length 8 for a string IN of length 8 and a string KEY
of length 8.
+ "Return hash string of length 8 for IN of length 8 and KEY of length 8.
FORW is t or nil."
(let ((out (make-string 8 0))
(inb (make-string 64 0))
diff --git a/lisp/net/tramp-gvfs.el b/lisp/net/tramp-gvfs.el
index 5f0e7bc..115d005 100644
--- a/lisp/net/tramp-gvfs.el
+++ b/lisp/net/tramp-gvfs.el
@@ -1833,8 +1833,9 @@ a downcased host name only."
result))))
(defun tramp-gvfs-handler-mounted-unmounted (mount-info)
- "Signal handler for the \"org.gtk.vfs.MountTracker.mounted\" and \
-\"org.gtk.vfs.MountTracker.unmounted\" signals."
+ "Signal handler for the gvfs \"mounted\" and \"unmounted\" signals.
+Their full names are \"org.gtk.vfs.MountTracker.mounted\" and
+\"org.gtk.vfs.MountTracker.unmounted\"."
(ignore-errors
(let ((signal-name (dbus-event-member-name last-input-event))
(elt mount-info))
@@ -2090,8 +2091,10 @@ It was \"a(say)\", but has changed to \"a{sv})\"."
`(:struct ,(tramp-gvfs-dbus-string-to-byte-array mount-pref) ,mount-spec)))
(defun tramp-gvfs-handler-volumeadded-volumeremoved (_dbus-name _id volume)
- "Signal handler for the \"org.gtk.Private.RemoteVolumeMonitor.VolumeAdded\" \
-and \"org.gtk.Private.RemoteVolumeMonitor.VolumeRemoved\" signals."
+ "Signal handler for the gvfs \"VolumeAdded\" and \"VolumeRemoved\" signals.
+Their full names are
+\"org.gtk.Private.RemoteVolumeMonitor.VolumeAdded\" and
+\"org.gtk.Private.RemoteVolumeMonitor.VolumeRemoved\"."
(ignore-errors
(let* ((signal-name (dbus-event-member-name last-input-event))
(uri (url-generic-parse-url (nth 5 volume)))
diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el
index 7f1a52f..1cdfef0 100644
--- a/lisp/net/tramp-sh.el
+++ b/lisp/net/tramp-sh.el
@@ -1701,7 +1701,7 @@ ID-FORMAT valid values are `string' and `integer'."
;; FIXME: Fix function to work with count parameter.
(defun tramp-do-directory-files-and-attributes-with-stat
(vec localname &optional id-format)
- "Implement `directory-files-and-attributes' for Tramp files using stat(1)
command."
+ "Implement `directory-files-and-attributes' for Tramp files with stat(1)
command."
(tramp-message vec 5 "directory-files-and-attributes with stat: %s"
localname)
(tramp-send-command-and-read
vec
diff --git a/lisp/org/ob-table.el b/lisp/org/ob-table.el
index 39a14a2..e081708 100644
--- a/lisp/org/ob-table.el
+++ b/lisp/org/ob-table.el
@@ -78,7 +78,8 @@ So this `org-sbe' construct
is the equivalent of the following source code block:
- #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3)
:results silent
+ #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) \\
+ :results silent
results
#+end_src
diff --git a/lisp/org/org-agenda.el b/lisp/org/org-agenda.el
index 23c6280..271eac1 100644
--- a/lisp/org/org-agenda.el
+++ b/lisp/org/org-agenda.el
@@ -1230,7 +1230,8 @@ For example, 9:30am would become 09:30 rather than 9:30."
":" minute ampm)))
(defun org-agenda-time-of-day-to-ampm-maybe (time)
- "Conditionally convert TIME to AM/PM format based on
`org-agenda-timegrid-use-ampm'."
+ "Conditionally convert TIME to AM/PM format.
+This is based on `org-agenda-timegrid-use-ampm'."
(if org-agenda-timegrid-use-ampm
(org-agenda-time-of-day-to-ampm time)
time))
diff --git a/lisp/org/org-protocol.el b/lisp/org/org-protocol.el
index 726c1ca..ff8c08d 100644
--- a/lisp/org/org-protocol.el
+++ b/lisp/org/org-protocol.el
@@ -178,11 +178,11 @@ Possible properties are:
:working-suffix - the replacement for online-suffix
:base-url - the base URL, e.g. http://www.example.com/project/
Last slash required.
- :working-directory - the local working directory. This is, what base-url
will
- be replaced with.
- :redirects - A list of cons cells, each of which maps a regular
- expression to match to a path relative to
- :working-directory.
+ :working-directory - the local working directory. This is what
+ base-url will be replaced with.
+ :redirects - A list of cons cells, each of which maps a
+ regular expression to match to a path relative
+ to `:working-directory'.
Example:
@@ -216,8 +216,9 @@ Example:
does not include any suffix properties, allowing local source
file to be opened as found by OpenGrok.
-Consider using the interactive functions `org-protocol-create' and
-`org-protocol-create-for-org' to help you filling this variable with valid
contents."
+Consider using the interactive functions `org-protocol-create'
+and `org-protocol-create-for-org' to help you filling this
+variable with valid contents."
:group 'org-protocol
:type 'alist)
diff --git a/lisp/play/doctor.el b/lisp/play/doctor.el
index b855f7e3..33fecaa 100644
--- a/lisp/play/doctor.el
+++ b/lisp/play/doctor.el
@@ -1011,8 +1011,8 @@ Put dialogue in buffer."
(defun doctor-subjsearch (sent key type)
"Search for the subject of a sentence SENT, looking for the noun closest
-to and preceding KEY by at least TYPE words. Set global variable
`doctor-subj' to
-the subject noun, and return the portion of the sentence following it."
+to and preceding KEY by at least TYPE words. Set global variable `doctor-subj'
+to the subject noun, and return the portion of the sentence following it."
(let ((i (- (length sent) (length (memq key sent)) type)))
(while (and (> i -1) (not (doctor-nounp (nth i sent))))
(setq i (1- i)))
diff --git a/lisp/progmodes/cc-cmds.el b/lisp/progmodes/cc-cmds.el
index 6c3da66..d40433a 100644
--- a/lisp/progmodes/cc-cmds.el
+++ b/lisp/progmodes/cc-cmds.el
@@ -480,7 +480,7 @@ function to control that."
;; This function is only used in XEmacs.
(defun c-hungry-delete ()
- "Delete a non-whitespace char, or all whitespace up to the next
non-whitespace char.
+ "Delete non-whitespace char, or all whitespace up to next non-whitespace
char.
The direction of deletion depends on the configuration: If the
function `delete-forward-p' is defined and returns non-nil, it deletes
forward using `c-hungry-delete-forward'. Otherwise it deletes
diff --git a/lisp/progmodes/flymake-proc.el b/lisp/progmodes/flymake-proc.el
index 27b46a4..7f2aa0f 100644
--- a/lisp/progmodes/flymake-proc.el
+++ b/lisp/progmodes/flymake-proc.el
@@ -902,7 +902,7 @@ can also be executed interactively independently of
temp-dir))))
(defun flymake-proc--delete-temp-directory (dir-name)
- "Attempt to delete temp dir created by
`flymake-proc-create-temp-with-folder-structure', do not fail on error."
+ "Attempt to delete temp dir DIR-NAME, do not fail on error."
(let* ((temp-dir temporary-file-directory)
(suffix (substring dir-name (1+ (length (directory-file-name
temp-dir))))))
@@ -919,7 +919,8 @@ can also be executed interactively independently of
(defvar-local flymake-proc--base-dir nil)
(defun flymake-proc-init-create-temp-buffer-copy (create-temp-f)
- "Make a temporary copy of the current buffer, save its name in buffer data
and return the name."
+ "Make a temporary copy of the current buffer, save its name in buffer data.
+Return the name."
(let* ((source-file-name buffer-file-name)
(temp-source-file-name (funcall create-temp-f source-file-name
"flymake")))
@@ -1007,7 +1008,7 @@ Return full-name. Names are real, not patched."
buildfile-name source-file-name)))))
(defun flymake-proc--init-create-temp-source-and-master-buffer-copy
(get-incl-dirs-f create-temp-f master-file-masks include-regexp)
- "Find master file (or buffer), create its copy along with a copy of the
source file."
+ "Find master file (or buffer), create its copy and a copy of the source
file."
(let* ((source-file-name buffer-file-name)
(temp-source-file-name (flymake-proc-init-create-temp-buffer-copy
create-temp-f))
(master-and-temp-master (flymake-proc--create-master-file
diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el
index d6828ee..4224e47 100644
--- a/lisp/progmodes/idlwave.el
+++ b/lisp/progmodes/idlwave.el
@@ -1522,7 +1522,8 @@ No spaces before and 1 after a comma
A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
(idlwave-action-and-binding \"=\" (lambda (_) (idlwave-expand-equal -1
-1)))
Capitalize system variables - action only
- (idlwave-action-and-binding idlwave-sysvar (lambda (_) (capitalize-word 1)
t))"
+ (idlwave-action-and-binding idlwave-sysvar
+ (lambda (_) (capitalize-word 1) t))"
(if (not (equal select 'noaction))
;; Add action
(let* ((table (if select 'idlwave-indent-action-table
diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el
index 33ca01c..74a0237 100644
--- a/lisp/progmodes/prolog.el
+++ b/lisp/progmodes/prolog.el
@@ -2136,7 +2136,8 @@ A return value of N means N more left parentheses than
right ones."
(line-end-position)))))
(defun prolog-electric--if-then-else ()
- "Insert spaces after the opening parenthesis, \"then\" (->) and \"else\" (;)
branches.
+ "Insert spaces after the opening parenthesis.
+\"then\" (->) and \"else\" (;) branches.
Spaces are inserted if all preceding objects on the line are
whitespace characters, parentheses, or then/else branches."
(when prolog-electric-if-then-else-flag
diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el
index ac6a8fb..d98230d 100644
--- a/lisp/progmodes/verilog-mode.el
+++ b/lisp/progmodes/verilog-mode.el
@@ -4038,9 +4038,12 @@ Some other functions are:
\\[verilog-sk-repeat] Insert a repeat (..) begin .. end block.
\\[verilog-sk-specify] Insert a specify .. endspecify block.
\\[verilog-sk-task] Insert a task .. begin .. end endtask block.
- \\[verilog-sk-while] Insert a while (...) begin .. end block, prompting
for details.
- \\[verilog-sk-casex] Insert a casex (...) item: begin.. end endcase
block, prompting for details.
- \\[verilog-sk-casez] Insert a casez (...) item: begin.. end endcase
block, prompting for details.
+ \\[verilog-sk-while] Insert a while (...) begin .. end block,
+ prompting for details.
+ \\[verilog-sk-casex] Insert a casex (...) item: begin.. end endcase block,
+ prompting for details.
+ \\[verilog-sk-casez] Insert a casez (...) item: begin.. end endcase block,
+ prompting for details.
\\[verilog-sk-if] Insert an if (..) begin .. end block.
\\[verilog-sk-else-if] Insert an else if (..) begin .. end block.
\\[verilog-sk-comment] Insert a comment block.
@@ -6580,7 +6583,8 @@ Return >0 for nested struct."
nil))))
(defun verilog-at-constraint-p ()
- "If at the { of a constraint or coverpoint definition, return true, moving
point to constraint."
+ "If at the { of a constraint or coverpoint definition, return true.
+Also move point to constraint."
(if (save-excursion
(let ((p (point)))
(and
@@ -14985,7 +14989,9 @@ but instead, [[Fill in here]] happens!.
(provide 'verilog-mode)
+;;TODO: Could `byte-compile-docstring-max-column' be decreased?
;; Local Variables:
+;; byte-compile-docstring-max-column: 90
;; checkdoc-permit-comma-termination-flag:t
;; checkdoc-force-docstrings-flag:nil
;; indent-tabs-mode:nil
diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el
index d0a1b3b..94242eb 100644
--- a/lisp/tab-bar.el
+++ b/lisp/tab-bar.el
@@ -1007,7 +1007,8 @@ on the tab bar instead."
When this command is bound to a numeric key (with a prefix or modifier key
using `tab-bar-select-tab-modifiers'), calling it without an argument
will translate its bound numeric key to the numeric argument.
-TAB-NUMBER counts from 1. Negative TAB-NUMBER counts tabs from the end of the
tab bar."
+TAB-NUMBER counts from 1. Negative TAB-NUMBER counts tabs from the end of
+the tab bar."
(interactive "P")
(unless (integerp tab-number)
(let ((key (event-basic-type last-command-event)))
@@ -1907,7 +1908,7 @@ Letters do not insert themselves; instead, they are
commands.
(move-to-column tab-switcher-column))
(defun tab-switcher-unmark (&optional backup)
- "Cancel all requested operations on window configuration on this line and
move down.
+ "Cancel requested operations on window configuration on this line and move
down.
Optional prefix arg means move up."
(interactive "P")
(beginning-of-line)
@@ -1919,7 +1920,7 @@ Optional prefix arg means move up."
(move-to-column tab-switcher-column))
(defun tab-switcher-backup-unmark ()
- "Move up and cancel all requested operations on window configuration on line
above."
+ "Move up one line and cancel requested operations on window configuration
there."
(interactive)
(forward-line -1)
(tab-switcher-unmark)
diff --git a/lisp/textmodes/texinfo.el b/lisp/textmodes/texinfo.el
index 135a404..7876a87 100644
--- a/lisp/textmodes/texinfo.el
+++ b/lisp/textmodes/texinfo.el
@@ -806,7 +806,8 @@ temporary file before the region itself. The buffer's
header is all lines
between the strings defined by `tex-start-of-header' and `tex-end-of-header'
inclusive. The header must start in the first 100 lines.
-The value of `texinfo-tex-trailer' is appended to the temporary file after the
region."
+The value of `texinfo-tex-trailer' is appended to the temporary
+file after the region."
(interactive "r")
(require 'tex-mode)
(let ((tex-command texinfo-tex-command)
diff --git a/lisp/vc/ediff-merg.el b/lisp/vc/ediff-merg.el
index 2bdce9e..d0ce9d3 100644
--- a/lisp/vc/ediff-merg.el
+++ b/lisp/vc/ediff-merg.el
@@ -257,7 +257,8 @@ Buffer B."
(defun ediff-re-merge ()
- "Remerge unmodified diff regions using a new default. Start with the
current region."
+ "Remerge unmodified diff regions using a new default.
+Start with the current region."
(interactive)
(let* ((default-variant-alist
(list '("default-A") '("default-B") '("combined")))
diff --git a/lisp/vc/ediff.el b/lisp/vc/ediff.el
index 74ed1bd..e406275 100644
--- a/lisp/vc/ediff.el
+++ b/lisp/vc/ediff.el
@@ -680,7 +680,7 @@ MERGE-AUTOSTORE-DIR is the directory in which to store
merged files."
(defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
&optional
merge-autostore-dir)
- "Merge files in directories DIR1 and DIR2 using files in ANCESTOR-DIR as
ancestors.
+ "Merge files in DIR1 and DIR2 using files in ANCESTOR-DIR as ancestors.
Ediff merges files that have identical names in DIR1, DIR2. If a pair of files
in DIR1 and DIR2 doesn't have an ancestor in ANCESTOR-DIR, Ediff will merge
without ancestor. The fourth argument, REGEXP, is nil or a regular expression;
@@ -746,7 +746,7 @@ MERGE-AUTOSTORE-DIR is the directory in which to store
merged files."
(defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
&optional
merge-autostore-dir)
- "Run Ediff on a directory, DIR1, merging its files with their revisions and
ancestors.
+ "Run Ediff on DIR1 and merge its files with their revisions and ancestors.
The second argument, REGEXP, is a regular expression that filters the file
names. Only the files that are under revision control are taken into account.
MERGE-AUTOSTORE-DIR is the directory in which to store merged files."
@@ -1600,7 +1600,8 @@ With optional NODE, goes to that node."
;;;###autoload
(defun ediff-merge-with-ancestor-command ()
- "Call `ediff-merge-files-with-ancestor' with the next three command line
arguments."
+ "Call `ediff-merge-files-with-ancestor' with the next three command line
+arguments."
(let ((file-a (nth 0 command-line-args-left))
(file-b (nth 1 command-line-args-left))
(ancestor (nth 2 command-line-args-left)))
@@ -1637,7 +1638,8 @@ With optional NODE, goes to that node."
;;;###autoload
(defun ediff-merge-directories-with-ancestor-command ()
- "Call `ediff-merge-directories-with-ancestor' with the next four command
line arguments."
+ "Call `ediff-merge-directories-with-ancestor' with the next four command line
+arguments."
(let ((file-a (nth 0 command-line-args-left))
(file-b (nth 1 command-line-args-left))
(ancestor (nth 2 command-line-args-left))
diff --git a/lisp/vc/vc-annotate.el b/lisp/vc/vc-annotate.el
index 45bb177..5a4ac1a 100644
--- a/lisp/vc/vc-annotate.el
+++ b/lisp/vc/vc-annotate.el
@@ -610,7 +610,8 @@ the file in question, search for the log entry required and
move point."
(vc-annotate-show-diff-revision-at-line-internal t))
(defun vc-annotate-show-changeset-diff-revision-at-line ()
- "Visit the diff of the revision at line from its previous revision for all
files in the changeset."
+ "Visit diff of revision at line from previous revision.
+This is done for all files in changeset."
(interactive)
(when (eq 'file (vc-call-backend vc-annotate-backend 'revision-granularity))
(error "The %s backend does not support changeset diffs"
vc-annotate-backend))
diff --git a/lisp/vc/vc-dir.el b/lisp/vc/vc-dir.el
index f8b8717..d079b89 100644
--- a/lisp/vc/vc-dir.el
+++ b/lisp/vc/vc-dir.el
@@ -1015,7 +1015,8 @@ child files."
(nreverse result)))
(defun vc-dir-child-files-and-states ()
- "Return the list of conses (FILE . STATE) for child files of the current
entry if it's a directory.
+ "Return list of conses for child files of the current entry if it's a
directory.
+The conses have the format (FILE . STATE).
If it is a file, return the corresponding cons for the file itself."
(let* ((crt (ewoc-locate vc-ewoc))
(crt-data (ewoc-data crt))
diff --git a/lisp/vc/vc-dispatcher.el b/lisp/vc/vc-dispatcher.el
index cd23bcc..346974b 100644
--- a/lisp/vc/vc-dispatcher.el
+++ b/lisp/vc/vc-dispatcher.el
@@ -404,7 +404,7 @@ Display the buffer in some window, but don't select it."
(defvar compilation-error-regexp-alist)
(defun vc-compilation-mode (backend)
- "Setup `compilation-mode' after with the appropriate
`compilation-error-regexp-alist'."
+ "Setup `compilation-mode' with the appropriate
`compilation-error-regexp-alist'."
(require 'compile)
(let* ((error-regexp-alist
(vc-make-backend-sym backend 'error-regexp-alist))
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 8767969..61d985c 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -2620,7 +2620,7 @@ with its diffs (if the underlying VCS supports that)."
;;;###autoload
(defun vc-log-incoming (&optional remote-location)
- "Show a log of changes that will be received with a pull operation from
REMOTE-LOCATION.
+ "Show log of changes that will be received with pull from REMOTE-LOCATION.
When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
(interactive
(when current-prefix-arg
@@ -2633,7 +2633,7 @@ When called interactively with a prefix argument, prompt
for REMOTE-LOCATION."
;;;###autoload
(defun vc-log-outgoing (&optional remote-location)
- "Show a log of changes that will be sent with a push operation to
REMOTE-LOCATION.
+ "Show log of changes that will be sent with a push operation to
REMOTE-LOCATION.
When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
(interactive
(when current-prefix-arg
diff --git a/lisp/whitespace.el b/lisp/whitespace.el
index d4f2b28..6e132de 100644
--- a/lisp/whitespace.el
+++ b/lisp/whitespace.el
@@ -2193,8 +2193,8 @@ resultant list will be returned."
limit t))
(defun whitespace-empty-at-bob-regexp (limit)
- "Match spaces at beginning of buffer which do not contain the point at \
-beginning of buffer."
+ "Match spaces at beginning of buffer which do not contain
+the point at beginning of buffer."
(let ((b (point))
r)
(cond
diff --git a/test/lisp/auth-source-pass-tests.el
b/test/lisp/auth-source-pass-tests.el
index a0a97ec..3da6f3e 100644
--- a/test/lisp/auth-source-pass-tests.el
+++ b/test/lisp/auth-source-pass-tests.el
@@ -97,7 +97,8 @@ This function is intended to be set to `auth-source-debug'."
(defun auth-source-pass--explain-match-entry-p (entry hostname &optional user
port)
"Explainer function for `auth-source-pass-match-entry-p'.
-ENTRY, HOSTNAME, USER and PORT are the same as in
`auth-source-pass-match-entry-p'."
+ENTRY, HOSTNAME, USER and PORT are the same as in
+`auth-source-pass-match-entry-p'."
`(entry
,entry
store
@@ -122,7 +123,8 @@ HOSTNAME, USER and PORT are passed unchanged to
(defun auth-source-pass--explain-includes-sorted-entries (entries hostname
&optional user port)
"Explainer function for `auth-source-pass--includes-sorted-entries'.
-ENTRIES, HOSTNAME, USER and PORT are the same as in
`auth-source-pass--includes-sorted-entries'."
+ENTRIES, HOSTNAME, USER and PORT are the same as in
+`auth-source-pass--includes-sorted-entries'."
`(store
,(auth-source-pass-entries)
matching-entries
diff --git a/test/lisp/international/ucs-normalize-tests.el
b/test/lisp/international/ucs-normalize-tests.el
index 52c3d37..eb577b9 100644
--- a/test/lisp/international/ucs-normalize-tests.el
+++ b/test/lisp/international/ucs-normalize-tests.el
@@ -123,9 +123,9 @@ The following invariants must be true for all conformant
implementations..."
(defsubst ucs-normalize-tests--rule2-holds-p (X)
"Check 2nd conformance rule.
-For every code point X assigned in this version of Unicode that is not
specifically
-listed in Part 1, the following invariants must be true for all conformant
-implementations:
+For every code point X assigned in this version of Unicode that
+is not specifically listed in Part 1, the following invariants
+must be true for all conformant implementations:
X == toNFC(X) == toNFD(X) == toNFKC(X) == toNFKD(X)"
(and (ucs-normalize-tests--normalization-chareq-p NFC X X)
- branch scratch/bug-44858 created (now 35c459f), Stefan Kangas, 2021/09/24
- scratch/bug-44858 2f59fad 1/6: ; Adjust overly long docstrings to fit 80 characters,
Stefan Kangas <=
- scratch/bug-44858 4e7c5a6 2/6: Improve filling of generated docstring lines, Stefan Kangas, 2021/09/24
- scratch/bug-44858 e491d97 3/6: Avoid false positives in bytecomp docstring width warning, Stefan Kangas, 2021/09/24
- scratch/bug-44858 35c459f 6/6: Warn about overly long docstring in lambda, Stefan Kangas, 2021/09/24
- scratch/bug-44858 e4fd496 4/6: Fill some auto-generated docstring lines, Stefan Kangas, 2021/09/24
- scratch/bug-44858 60edb5d 5/6: Avoid warning about long docstring lines in defcustom, Stefan Kangas, 2021/09/24