]> git.eshelyaron.com Git - emacs.git/commitdiff
; Adjust overly long docstrings to fit 80 characters
authorStefan Kangas <stefan@marxist.se>
Fri, 24 Sep 2021 12:46:56 +0000 (14:46 +0200)
committerStefan Kangas <stefan@marxist.se>
Sun, 26 Sep 2021 11:23:57 +0000 (13:23 +0200)
45 files changed:
lisp/array.el
lisp/cedet/data-debug.el
lisp/cedet/semantic/analyze/complete.el
lisp/cedet/semantic/db-find.el
lisp/cedet/semantic/tag-ls.el
lisp/emacs-lisp/eieio-core.el
lisp/emacs-lisp/seq.el
lisp/emulation/viper-cmd.el
lisp/emulation/viper-init.el
lisp/erc/erc-backend.el
lisp/erc/erc-dcc.el
lisp/frameset.el
lisp/gnus/gnus-agent.el
lisp/gnus/gnus-bookmark.el
lisp/gnus/gnus-fun.el
lisp/gnus/gnus-group.el
lisp/gnus/gnus-score.el
lisp/gnus/gnus-sum.el
lisp/gnus/nnvirtual.el
lisp/net/dbus.el
lisp/net/dictionary.el
lisp/net/eudc.el
lisp/net/ntlm.el
lisp/net/tramp-gvfs.el
lisp/net/tramp-sh.el
lisp/org/ob-table.el
lisp/org/org-agenda.el
lisp/org/org-protocol.el
lisp/play/doctor.el
lisp/progmodes/cc-cmds.el
lisp/progmodes/flymake-proc.el
lisp/progmodes/idlwave.el
lisp/progmodes/prolog.el
lisp/progmodes/verilog-mode.el
lisp/tab-bar.el
lisp/textmodes/texinfo.el
lisp/vc/ediff-merg.el
lisp/vc/ediff.el
lisp/vc/vc-annotate.el
lisp/vc/vc-dir.el
lisp/vc/vc-dispatcher.el
lisp/vc/vc.el
lisp/whitespace.el
test/lisp/auth-source-pass-tests.el
test/lisp/international/ucs-normalize-tests.el

index 6632da55dd491e3af6379fe83a8d2344c9e8907a..2c9a6815d259f54ffe0500a7ceaab2be34b706d9 100644 (file)
@@ -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
index 428848be04d2c8ea7796cb6746a2b1eec94d7d92..8f40a4db79d059e46a83bdd689e9cfa5e1a446ae 100644 (file)
@@ -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
index 1e8cd9af0884b5a487d051f09754728a53d99602..5c3228ae1664bfb3aed972b7531e00477b16fb30 100644 (file)
@@ -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
index 61baaa020f8055f4a934a71340f161c85fba401f..e6a7879775ecb096a1baf2891ecfc8ae45e4ea29 100644 (file)
@@ -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)
index 3aa1a62901c54318df1f37afcf6b8f271321e30f..4bdae58690a494768b28daaa4bd35282f7729ed4 100644 (file)
@@ -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.
 
index b11ed3333f0db818b847b3d340616de626770267..80d1711d817429858514f7191cce9c30838b83cc 100644 (file)
@@ -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)
index e7258c2da495dda7f72d60bed34190b89caf80dd..52c080388b79f1f6da85773f6b26a063a1c956eb 100644 (file)
@@ -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 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))
index c3b36f10aedce05298db6406915ea12e691833ca..b132d786eb10e301103a5dab40a3e2eb1fcf3801 100644 (file)
@@ -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."
index 730ca0b5a2e14e60af757f9e3ce04babfed0f03e..ffcb4602e739d2112680d75243969299db1ffb16 100644 (file)
@@ -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."
index 10be2965ad7e952c23b05175c3a2f625110ae2d2..140755fab51c1490fb7a69207d21042b008acae2 100644 (file)
@@ -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?
index 147b90291ad94fbf0007676691e739d9879c52e5..db278a1275c56a4421fe8afa18c2cbc4e47c32ef 100644 (file)
@@ -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
index cdbac0a48c3260c7d205217a45cf442369488c28..998f4fb4ca4fb712bcce8eaa388f18e556795a8f 100644 (file)
@@ -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:
index 961965d9284145b7a171378871a94b305c064bf5..19d05120045f9cb4b8d3351b5a09ca8e68ddf124 100644 (file)
@@ -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)
index 8c2a928ab9879e0a44d3c8a42ad042b4eb222ea4..83e482f14c10c21e6bec98899eb3dc99cf68b071 100644 (file)
@@ -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))
index bfc57a2d605b894887c599e6640c14dc94e18ca1..0754d7aa7b8b00b77b419b52b7a8a5b5df98e8d7 100644 (file)
@@ -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
index aea8cbbf78c5ccaed6803c99dd3a13d698bb69c5..b1e486b0627b463757169700b2547c8043c506ba 100644 (file)
@@ -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))
index 0626e8bde5c8908768e8afb790956d6572105d0a..e0ad9f698d33605243054066b2cf8ee65cab0409 100644 (file)
@@ -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)
index 2ddd3d2a7e0daf872cca29982f15c21b3b1fb5ac..b3d0460032de47652f32e7da76da9c8dcb6fa9ee 100644 (file)
@@ -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
index 03a0ff296f2cb8dc1785c772a0e66a6dad578314..4136392c825de08dc431d0f6e600c1ed13d7efa3 100644 (file)
@@ -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)
index 4116d293e1bd2f152cb3be0d6e0b097d3d877359..560ece675174ed9f376b41d2dd20a63127245efc 100644 (file)
@@ -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
index 85467cd782815d73694114718d47c6cbba0c080b..09d250fd7bf760fa9c0f98825f45c165f2e8c085 100644 (file)
@@ -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
index 5c451c6556d7970fc99d1fc79f7b0d868e7eb763..14e5c28b2dcc0c716ec9fd55493e401daef9c103 100644 (file)
@@ -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
index 747a69fb5d4d7b4abfbbdc594bf8390b29b5cadf..0e0146df969b0b7c273ba559204326156d7d2065 100644 (file)
@@ -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))
index 5f0e7bcd98c786f739a24dc0ae53225397940b28..115d005c0ca6bfe9e615585aeef7fd9ab84f1378 100644 (file)
@@ -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)))
index 0fe106684c5bbb9d1acd557c5a7ee38de9169642..dd92f2268972f9b115fd59a639b16b49ff6a6ed1 100644 (file)
@@ -1699,7 +1699,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
index 39a14a25d6c91154af820752ff57d6b7a1d850a8..e081708701dd4645c4725759d0d6e64b1ce5c451 100644 (file)
@@ -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
 
index 23c62809a2b28ecec2955f9d082576ed4b837bd4..271eac1c30d322d555450e0aec8b7a3610f0f569 100644 (file)
@@ -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))
index 726c1ca2bae5c84f026f25a61305f6cdf69b7f0f..ff8c08d5c5fe3345cc58b30af533df178472ba7d 100644 (file)
@@ -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)
 
index b855f7e35a1e25c967403ea4d146745be21a7338..33fecaa188aca4acd584d8379efaf1872bba786c 100644 (file)
@@ -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)))
index 6c3da667bfcedcb6ec7552e2203acf285ec8df3b..d40433a9b0d1ae313d7ca8d156920c01ec98f1b0 100644 (file)
@@ -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
index 27b46a45c50275b771ab8b5b16d43243385c3732..7f2aa0f469fa1445dc75da2e0c0d48fe4edccdff 100644 (file)
@@ -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
index d6828eeffbbb2fda121603d2f4c9b12291815ded..4224e47d16df329261c629303d10e52bd2e4639d 100644 (file)
@@ -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
index 33ca01cc754c62ef11fdd823f6f9a37c698ee1aa..74a023775f85d058d0f6a62cff1e70e429178881 100644 (file)
@@ -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
index ac6a8fbbcb1e56d575da9c5ea142c019c3b6e64f..d98230d9a0ebe67588474caf20f03273becba9b4 100644 (file)
@@ -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
index ceacd85971ddb9448f0679e273f1d696c4cc6a36..abf0e814c417cf5b2e63f20377d751e9817e286d 100644 (file)
@@ -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)))
@@ -1908,7 +1909,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)
@@ -1920,7 +1921,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)
index 135a404731811811206b174b71c0a839ff30ad5d..7876a87a2815356b2f44c2b83d51cc884b40cdf7 100644 (file)
@@ -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)
index 2bdce9e33c7ca4368b39b3db27bbf0509530a6e3..d0ce9d326d8f3e0cb03636efa2056830ed8ef390 100644 (file)
@@ -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")))
index 74ed1bd0ef28429d3d8019d9a7df6e8a859fb0a2..e406275cd1a74326dd3aa7eb03c054b88619da5f 100644 (file)
@@ -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))
index 45bb17749bcbbd2fd646b8fc9941559337e2f3a9..5a4ac1aca84baa8b23f045806ae22fb307a7fe4d 100644 (file)
@@ -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))
index f8b87170af5e9ba92396238b3e5498fea4218075..d079b891e4df7952362c2a25fdd2d03d9cc84e5a 100644 (file)
@@ -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))
index cd23bcce9411103a0534ff4d2524a0492d516538..346974bdba8b9ebabbffb44afd9b5288372e2a3c 100644 (file)
@@ -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))
index 7d3b0f56f607813bded4da78c41aca6db8311bef..5b259fcdb33956973347f0a4b9bdafd6896a3988 100644 (file)
@@ -2624,7 +2624,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
@@ -2637,7 +2637,7 @@ When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
 
 ;;;###autoload
 (defun vc-log-outgoing (&optional remote-location)
-  "Show 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
index d4f2b2890a8fc460c57abf8b7aae47d7a1f72e8e..6e132de536d714c508c5b329d8881159a56ca15a 100644 (file)
@@ -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
index a0a97eca5eb2c3ca1ff8ff3697e721b030f2b6fe..3da6f3e9b7b0cf0379d256966715f75a737bd837 100644 (file)
@@ -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
index 52c3d3704ebd744397597900590c4baa177d32e2..eb577b97dc4218e878f5a8bcc613ae78c14cef79 100644 (file)
@@ -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)