1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00

; Adjust overly long docstrings to fit 80 characters

This commit is contained in:
Stefan Kangas 2021-09-24 14:46:56 +02:00
parent f4ea15907a
commit c78e16962e
45 changed files with 138 additions and 87 deletions

View file

@ -805,8 +805,9 @@ NOT recognized as integers or real numbers.
The array MUST reside at the top of the buffer. The array MUST reside at the top of the buffer.
TABs are not respected, and may be converted into spaces at any time. 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, Setting the variable `array-respect-tabs' to non-nil will prevent
but will cause many functions to give errors if they encounter one. 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 Upon entering array mode, you will be prompted for the values of
several variables. Others will be calculated based on the values you several variables. Others will be calculated based on the values you

View 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) (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) (let ((string (propertize (format "%s" hash-table)
'face 'font-lock-keyword-face))) 'face 'font-lock-keyword-face)))
(insert (propertize (insert (propertize

View file

@ -70,7 +70,8 @@ context. Passing in a context is useful if the caller also needs
to access parts of the analysis. to access parts of the analysis.
The remaining FLAGS arguments are passed to the mode specific completion engine. The remaining FLAGS arguments are passed to the mode specific completion engine.
Bad flags should be ignored by modes that don't use them. 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: Completions run through the following filters:
* Elements currently in scope * Elements currently in scope

View file

@ -914,7 +914,7 @@ but should be good enough for debugging assertions."
(null (car (cdr (car resultp))))))) (null (car (cdr (car resultp)))))))
(defun semanticdb-find-result-prin1-to-string (result) (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) (if (< (length result) 2)
(concat "#<FIND RESULT " (concat "#<FIND RESULT "
(mapconcat (lambda (a) (mapconcat (lambda (a)

View file

@ -130,7 +130,10 @@ are the same.
Similar tags that have sub-tags such as arg lists or type members, Similar tags that have sub-tags such as arg lists or type members,
are similar w/out checking the sub-list of tags. 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 By default, `semantic-tag-similar-ignorable-attributes' is referenced for
attributes, and IGNORABLE-ATTRIBUTES will augment this list. 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. ;; will contain the info needed to determine the full name.
(define-overloadable-function semantic-tag-full-package (tag &optional stream-or-buffer) (define-overloadable-function semantic-tag-full-package (tag &optional stream-or-buffer)
"Return the fully qualified package name of TAG in a package hierarchy. "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', STREAM-OR-BUFFER can be anything convertible by
but must be a toplevel semantic tag stream that contains TAG. `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 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 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.) class can be accessed via it's fully qualified name, (such as Java.)
Other languages qualify names within a Namespace (such as C++) which Other languages qualify names within a Namespace (such as C++) which
result in a different package like structure. 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) (define-overloadable-function semantic-tag-full-name (tag &optional stream-or-buffer)
"Return the fully qualified name of TAG in the package hierarchy. "Return the fully qualified name of TAG in the package hierarchy.
STREAM-OR-BUFFER can be anything convertible by `semantic-something-to-tag-table', STREAM-OR-BUFFER can be anything convertible by
but must be a toplevel semantic tag stream that contains TAG. `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 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 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.) class can be accessed via it's fully qualified name, (such as Java.)
Other languages qualify names within a Namespace (such as C++) which Other languages qualify names within a Namespace (such as C++) which
result in a different package like structure. result in a different package like structure.

View file

@ -953,7 +953,7 @@ need be... May remove that later...)"
class)) class))
(defun eieio--c3-merge-lists (reversed-partial-result remaining-inputs) (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." If a consistent order does not exist, signal an error."
(setq remaining-inputs (delq nil remaining-inputs)) (setq remaining-inputs (delq nil remaining-inputs))
(if (null remaining-inputs) (if (null remaining-inputs)

View file

@ -529,7 +529,7 @@ SEQUENCE must be a sequence of numbers or markers."
(apply #'max (seq-into sequence 'list))) (apply #'max (seq-into sequence 'list)))
(defun seq--count-successive (pred sequence) (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) (let ((n 0)
(len (seq-length sequence))) (len (seq-length sequence)))
(while (and (< n len) (while (and (< n len)
@ -538,7 +538,7 @@ SEQUENCE must be a sequence of numbers or markers."
n)) n))
(defun seq--make-pcase-bindings (args) (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 '()) (let ((bindings '())
(index 0) (index 0)
(rest-marker nil)) (rest-marker nil))

View 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) (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. This is used in conjunction with the `%' command.
With a prefix argument, unsets the macro." With a prefix argument, unsets the macro."

View file

@ -932,7 +932,8 @@ Should be set in `viper-custom-file-name'."
(setq cursor-type '(bar . 2))) (setq cursor-type '(bar . 2)))
(defun viper-ESC-keyseq-timeout () (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 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 this value too low will make it impossible to use function keys in insert mode
on a dumb terminal." on a dumb terminal."

View file

@ -1532,7 +1532,8 @@ add things to `%s' instead."
'WALLOPS ?n nick ?m message)))) 'WALLOPS ?n nick ?m message))))
(define-erc-response-handler (001) (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 nil
(erc-set-current-nick (car (erc-response.command-args parsed))) (erc-set-current-nick (car (erc-response.command-args parsed)))
(erc-update-mode-line) ; needed here? (erc-update-mode-line) ; needed here?

View file

@ -164,9 +164,8 @@ Looks like:
;;; Misc macros and utility functions ;;; Misc macros and utility functions
(defun erc-dcc-member (&rest args) (defun erc-dcc-member (&rest args)
"Return first matching entry in `erc-dcc-list' satisfying constraints in plist ARGS. "Return first matching entry in `erc-dcc-list' satisfying constraints in ARGS.
ARGS is a plist. Return nil on no match.
Return nil on no match.
The property :nick is treated specially, if it contains a `!' character, 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 it is treated as a nick!user@host string, and compared with the :nick property

View file

@ -1178,7 +1178,8 @@ FORCE-ONSCREEN can be:
- a list (LEFT TOP WIDTH HEIGHT), describing the workarea. - a list (LEFT TOP WIDTH HEIGHT), describing the workarea.
It must return non-nil to force the frame onscreen, nil otherwise. 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. t Delete all frames that were not created or restored upon.
nil Keep all frames. nil Keep all frames.
FUNC A function called with two arguments: FUNC A function called with two arguments:

View file

@ -1323,7 +1323,7 @@ downloaded into the agent."
(gnus-agent-set-local group agent-min (1- active-min))))))) (gnus-agent-set-local group agent-min (1- active-min)))))))
(defun gnus-agent-save-group-info (method group active) (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) (when (gnus-agent-method-p method)
(let* ((gnus-command-method (or method gnus-command-method)) (let* ((gnus-command-method (or method gnus-command-method))
(coding-system-for-write nnheader-file-coding-system) (coding-system-for-write nnheader-file-coding-system)
@ -1356,7 +1356,7 @@ downloaded into the agent."
(delete-char 1))))))) (delete-char 1)))))))
(defun gnus-agent-get-group-info (method group) (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) (when (gnus-agent-method-p method)
(let* ((gnus-command-method (or method gnus-command-method)) (let* ((gnus-command-method (or method gnus-command-method))
(coding-system-for-write nnheader-file-coding-system) (coding-system-for-write nnheader-file-coding-system)

View file

@ -198,7 +198,9 @@ So the cdr of each bookmark is an alist too.")
(defun gnus-bookmark-make-record (defun gnus-bookmark-make-record
(group message-id author date subject annotation) (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 (let ((the-record
`((group . ,(substring-no-properties group)) `((group . ,(substring-no-properties group))
(message-id . ,(substring-no-properties message-id)) (message-id . ,(substring-no-properties message-id))

View file

@ -97,7 +97,8 @@ PNG format."
;;;###autoload ;;;###autoload
(defun gnus--random-face-with-type (dir ext omit fun) (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) (when (file-exists-p dir)
(let* ((files (let* ((files
(remove nil (mapcar (remove nil (mapcar

View file

@ -4062,7 +4062,8 @@ of groups killed."
(if (< (length out) 2) (car out) (nreverse out)))) (if (< (length out) 2) (car out) (nreverse out))))
(defun gnus-group-yank-group (&optional arg) (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 The numeric ARG specifies how many newsgroups are to be yanked. The
name of the newsgroup yanked is returned, or (if several groups are name of the newsgroup yanked is returned, or (if several groups are
yanked) a list of yanked groups is returned." 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)) (gnus-group-get-parameter group 'timestamp t))
(defun gnus-group-timestamp-delta (group) (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, ;; FIXME: This should return a Lisp integer, not a Lisp float,
;; since it is always an integer. ;; since it is always an integer.
(let* ((time (or (gnus-group-timestamp group) 0)) (let* ((time (or (gnus-group-timestamp group) 0))

View file

@ -3115,7 +3115,9 @@ If ADAPT, return the home adaptive file instead."
;;; ;;;
(defun gnus-decay-score (score) (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 (floor (- score
(* (if (< score 0) -1 1) (* (if (< score 0) -1 1)
(min (abs score) (min (abs score)

View file

@ -4357,7 +4357,8 @@ If SELECT-ARTICLES, only select those articles from GROUP."
result)) result))
(defun gnus-sort-gathered-threads (threads) (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)) (let ((result threads))
(while threads (while threads
(when (stringp (caar 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)) (gnus-article-sort-by-number h1 h2))
(defun gnus-thread-sort-by-most-recent-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))) (> (gnus-thread-highest-number h1) (gnus-thread-highest-number h2)))
(defun gnus-thread-highest-number (thread) (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)) (gnus-article-sort-by-date h1 h2))
(defun gnus-thread-sort-by-most-recent-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))) (> (gnus-thread-latest-date h1) (gnus-thread-latest-date h2)))
(defsubst gnus-article-sort-by-newsgroups (h1 h2) (defsubst gnus-article-sort-by-newsgroups (h1 h2)
@ -5651,7 +5652,7 @@ or a straight list of headers."
gnus-list-identifiers))) gnus-list-identifiers)))
(defun gnus-summary-remove-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)) (let ((regexp (gnus-group-get-list-identifiers gnus-newsgroup-name))
changed subject) changed subject)
(when regexp (when regexp

View file

@ -382,7 +382,8 @@ It is computed from the marks of individual component groups.")
(defun nnvirtual-update-xref-header (group article prefix sysname) (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. ;; Move to beginning of Xref field, creating a slot if needed.
(beginning-of-line) (beginning-of-line)
(looking-at (looking-at
@ -569,7 +570,8 @@ If UPDATE-P is not nil, call gnus-group-update-group on the components."
;; unique reverse mapping. ;; unique reverse mapping.
(defun nnvirtual-map-article (article) (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) (let ((table nnvirtual-mapping-table)
entry group-pos) entry group-pos)
(while (and table (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) (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) (when (numberp article)
(let ((table nnvirtual-mapping-table) (let ((table nnvirtual-mapping-table)
(group-pos 0) (group-pos 0)

View file

@ -2073,7 +2073,8 @@ either a method name, a signal name, or an error name."
(goto-char point))) (goto-char point)))
(defun dbus-monitor-handler (&rest _args) (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' It will be applied for all objects created by `dbus-register-monitor'
which don't declare an own handler. The printed timestamps do which don't declare an own handler. The printed timestamps do
not reflect the time the D-Bus message has passed the D-Bus not reflect the time the D-Bus message has passed the D-Bus

View file

@ -1049,7 +1049,7 @@ If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
'dictionary-display-match-result))) 'dictionary-display-match-result)))
(defun dictionary-do-matching (word dictionary strategy function) (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" (message "Lookup matching words for %s in %s using %s"
word dictionary strategy) word dictionary strategy)
(dictionary-send-command (dictionary-send-command

View file

@ -798,8 +798,9 @@ see `eudc-inline-expansion-servers'."
"Query the directory server, and return the matching responses. "Query the directory server, and return the matching responses.
The variable `eudc-inline-query-format' controls how to associate the The variable `eudc-inline-query-format' controls how to associate the
individual QUERY-WORDS with directory attribute names. individual QUERY-WORDS with directory attribute names.
After querying the server for the given string, the expansion specified by After querying the server for the given string, the expansion
`eudc-inline-expansion-format' is applied to the matches before returning them.inserted in the buffer at point. 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, Multiple servers can be tried with the same query until one finds a match,
see `eudc-inline-expansion-servers'." see `eudc-inline-expansion-servers'."
(cond (cond

View file

@ -436,7 +436,7 @@ PASSWD is truncated to 14 bytes if longer."
(make-string (- 15 len) 0))))) (make-string (- 15 len) 0)))))
(defun ntlm-smb-owf-encrypt (passwd c8) (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 PASSWD is of at most 14 bytes long and the challenge string C8 of
8 bytes long." 8 bytes long."
(let* ((len (min (length passwd) 16)) (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))) (substring p15 7) t)))
(defun ntlm-smb-hash (in key forw) (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." FORW is t or nil."
(let ((out (make-string 8 0)) (let ((out (make-string 8 0))
(inb (make-string 64 0)) (inb (make-string 64 0))

View file

@ -1833,8 +1833,9 @@ a downcased host name only."
result)))) result))))
(defun tramp-gvfs-handler-mounted-unmounted (mount-info) (defun tramp-gvfs-handler-mounted-unmounted (mount-info)
"Signal handler for the \"org.gtk.vfs.MountTracker.mounted\" and \ "Signal handler for the gvfs \"mounted\" and \"unmounted\" signals.
\"org.gtk.vfs.MountTracker.unmounted\" signals." Their full names are \"org.gtk.vfs.MountTracker.mounted\" and
\"org.gtk.vfs.MountTracker.unmounted\"."
(ignore-errors (ignore-errors
(let ((signal-name (dbus-event-member-name last-input-event)) (let ((signal-name (dbus-event-member-name last-input-event))
(elt mount-info)) (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))) `(:struct ,(tramp-gvfs-dbus-string-to-byte-array mount-pref) ,mount-spec)))
(defun tramp-gvfs-handler-volumeadded-volumeremoved (_dbus-name _id volume) (defun tramp-gvfs-handler-volumeadded-volumeremoved (_dbus-name _id volume)
"Signal handler for the \"org.gtk.Private.RemoteVolumeMonitor.VolumeAdded\" \ "Signal handler for the gvfs \"VolumeAdded\" and \"VolumeRemoved\" signals.
and \"org.gtk.Private.RemoteVolumeMonitor.VolumeRemoved\" signals." Their full names are
\"org.gtk.Private.RemoteVolumeMonitor.VolumeAdded\" and
\"org.gtk.Private.RemoteVolumeMonitor.VolumeRemoved\"."
(ignore-errors (ignore-errors
(let* ((signal-name (dbus-event-member-name last-input-event)) (let* ((signal-name (dbus-event-member-name last-input-event))
(uri (url-generic-parse-url (nth 5 volume))) (uri (url-generic-parse-url (nth 5 volume)))

View file

@ -1699,7 +1699,7 @@ ID-FORMAT valid values are `string' and `integer'."
;; FIXME: Fix function to work with count parameter. ;; FIXME: Fix function to work with count parameter.
(defun tramp-do-directory-files-and-attributes-with-stat (defun tramp-do-directory-files-and-attributes-with-stat
(vec localname &optional id-format) (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-message vec 5 "directory-files-and-attributes with stat: %s" localname)
(tramp-send-command-and-read (tramp-send-command-and-read
vec vec

View file

@ -78,7 +78,8 @@ So this `org-sbe' construct
is the equivalent of the following source code block: 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 results
#+end_src #+end_src

View file

@ -1230,7 +1230,8 @@ For example, 9:30am would become 09:30 rather than 9:30."
":" minute ampm))) ":" minute ampm)))
(defun org-agenda-time-of-day-to-ampm-maybe (time) (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 (if org-agenda-timegrid-use-ampm
(org-agenda-time-of-day-to-ampm time) (org-agenda-time-of-day-to-ampm time)
time)) time))

View file

@ -178,11 +178,11 @@ Possible properties are:
:working-suffix - the replacement for online-suffix :working-suffix - the replacement for online-suffix
:base-url - the base URL, e.g. http://www.example.com/project/ :base-url - the base URL, e.g. http://www.example.com/project/
Last slash required. Last slash required.
:working-directory - the local working directory. This is, what base-url will :working-directory - the local working directory. This is what
be replaced with. base-url will be replaced with.
:redirects - A list of cons cells, each of which maps a regular :redirects - A list of cons cells, each of which maps a
expression to match to a path relative to regular expression to match to a path relative
:working-directory. to `:working-directory'.
Example: Example:
@ -216,8 +216,9 @@ Example:
does not include any suffix properties, allowing local source does not include any suffix properties, allowing local source
file to be opened as found by OpenGrok. file to be opened as found by OpenGrok.
Consider using the interactive functions `org-protocol-create' and Consider using the interactive functions `org-protocol-create'
`org-protocol-create-for-org' to help you filling this variable with valid contents." and `org-protocol-create-for-org' to help you filling this
variable with valid contents."
:group 'org-protocol :group 'org-protocol
:type 'alist) :type 'alist)

View file

@ -1011,8 +1011,8 @@ Put dialogue in buffer."
(defun doctor-subjsearch (sent key type) (defun doctor-subjsearch (sent key type)
"Search for the subject of a sentence SENT, looking for the noun closest "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 to and preceding KEY by at least TYPE words. Set global variable `doctor-subj'
the subject noun, and return the portion of the sentence following it." to the subject noun, and return the portion of the sentence following it."
(let ((i (- (length sent) (length (memq key sent)) type))) (let ((i (- (length sent) (length (memq key sent)) type)))
(while (and (> i -1) (not (doctor-nounp (nth i sent)))) (while (and (> i -1) (not (doctor-nounp (nth i sent))))
(setq i (1- i))) (setq i (1- i)))

View file

@ -480,7 +480,7 @@ function to control that."
;; This function is only used in XEmacs. ;; This function is only used in XEmacs.
(defun c-hungry-delete () (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 The direction of deletion depends on the configuration: If the
function `delete-forward-p' is defined and returns non-nil, it deletes function `delete-forward-p' is defined and returns non-nil, it deletes
forward using `c-hungry-delete-forward'. Otherwise it deletes forward using `c-hungry-delete-forward'. Otherwise it deletes

View file

@ -902,7 +902,7 @@ can also be executed interactively independently of
temp-dir)))) temp-dir))))
(defun flymake-proc--delete-temp-directory (dir-name) (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) (let* ((temp-dir temporary-file-directory)
(suffix (substring dir-name (1+ (length (directory-file-name temp-dir)))))) (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) (defvar-local flymake-proc--base-dir nil)
(defun flymake-proc-init-create-temp-buffer-copy (create-temp-f) (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) (let* ((source-file-name buffer-file-name)
(temp-source-file-name (funcall create-temp-f source-file-name "flymake"))) (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))))) 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) (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) (let* ((source-file-name buffer-file-name)
(temp-source-file-name (flymake-proc-init-create-temp-buffer-copy create-temp-f)) (temp-source-file-name (flymake-proc-init-create-temp-buffer-copy create-temp-f))
(master-and-temp-master (flymake-proc--create-master-file (master-and-temp-master (flymake-proc--create-master-file

View 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'). A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
(idlwave-action-and-binding \"=\" (lambda (_) (idlwave-expand-equal -1 -1))) (idlwave-action-and-binding \"=\" (lambda (_) (idlwave-expand-equal -1 -1)))
Capitalize system variables - action only 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)) (if (not (equal select 'noaction))
;; Add action ;; Add action
(let* ((table (if select 'idlwave-indent-action-table (let* ((table (if select 'idlwave-indent-action-table

View file

@ -2136,7 +2136,8 @@ A return value of N means N more left parentheses than right ones."
(line-end-position))))) (line-end-position)))))
(defun prolog-electric--if-then-else () (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 Spaces are inserted if all preceding objects on the line are
whitespace characters, parentheses, or then/else branches." whitespace characters, parentheses, or then/else branches."
(when prolog-electric-if-then-else-flag (when prolog-electric-if-then-else-flag

View file

@ -4038,9 +4038,12 @@ Some other functions are:
\\[verilog-sk-repeat] Insert a repeat (..) begin .. end block. \\[verilog-sk-repeat] Insert a repeat (..) begin .. end block.
\\[verilog-sk-specify] Insert a specify .. endspecify block. \\[verilog-sk-specify] Insert a specify .. endspecify block.
\\[verilog-sk-task] Insert a task .. begin .. end endtask 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-while] Insert a while (...) begin .. end block,
\\[verilog-sk-casex] Insert a casex (...) item: begin.. end endcase block, prompting for details. prompting for details.
\\[verilog-sk-casez] Insert a casez (...) item: begin.. end endcase 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-if] Insert an if (..) begin .. end block.
\\[verilog-sk-else-if] Insert an else if (..) begin .. end block. \\[verilog-sk-else-if] Insert an else if (..) begin .. end block.
\\[verilog-sk-comment] Insert a comment block. \\[verilog-sk-comment] Insert a comment block.
@ -6580,7 +6583,8 @@ Return >0 for nested struct."
nil)))) nil))))
(defun verilog-at-constraint-p () (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 (if (save-excursion
(let ((p (point))) (let ((p (point)))
(and (and
@ -14985,7 +14989,9 @@ but instead, [[Fill in here]] happens!.
(provide 'verilog-mode) (provide 'verilog-mode)
;;TODO: Could `byte-compile-docstring-max-column' be decreased?
;; Local Variables: ;; Local Variables:
;; byte-compile-docstring-max-column: 90
;; checkdoc-permit-comma-termination-flag:t ;; checkdoc-permit-comma-termination-flag:t
;; checkdoc-force-docstrings-flag:nil ;; checkdoc-force-docstrings-flag:nil
;; indent-tabs-mode:nil ;; indent-tabs-mode:nil

View 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 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 using `tab-bar-select-tab-modifiers'), calling it without an argument
will translate its bound numeric key to the numeric 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") (interactive "P")
(unless (integerp tab-number) (unless (integerp tab-number)
(let ((key (event-basic-type last-command-event))) (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)) (move-to-column tab-switcher-column))
(defun tab-switcher-unmark (&optional backup) (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." Optional prefix arg means move up."
(interactive "P") (interactive "P")
(beginning-of-line) (beginning-of-line)
@ -1920,7 +1921,7 @@ Optional prefix arg means move up."
(move-to-column tab-switcher-column)) (move-to-column tab-switcher-column))
(defun tab-switcher-backup-unmark () (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) (interactive)
(forward-line -1) (forward-line -1)
(tab-switcher-unmark) (tab-switcher-unmark)

View 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' between the strings defined by `tex-start-of-header' and `tex-end-of-header'
inclusive. The header must start in the first 100 lines. 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") (interactive "r")
(require 'tex-mode) (require 'tex-mode)
(let ((tex-command texinfo-tex-command) (let ((tex-command texinfo-tex-command)

View file

@ -257,7 +257,8 @@ Buffer B."
(defun ediff-re-merge () (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) (interactive)
(let* ((default-variant-alist (let* ((default-variant-alist
(list '("default-A") '("default-B") '("combined"))) (list '("default-A") '("default-B") '("combined")))

View 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 (defun ediff-merge-directories-with-ancestor (dir1 dir2 ancestor-dir regexp
&optional &optional
merge-autostore-dir) 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 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 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; 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 (defun ediff-merge-directory-revisions-with-ancestor (dir1 regexp
&optional &optional
merge-autostore-dir) 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 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. 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." MERGE-AUTOSTORE-DIR is the directory in which to store merged files."
@ -1600,7 +1600,8 @@ With optional NODE, goes to that node."
;;;###autoload ;;;###autoload
(defun ediff-merge-with-ancestor-command () (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)) (let ((file-a (nth 0 command-line-args-left))
(file-b (nth 1 command-line-args-left)) (file-b (nth 1 command-line-args-left))
(ancestor (nth 2 command-line-args-left))) (ancestor (nth 2 command-line-args-left)))
@ -1637,7 +1638,8 @@ With optional NODE, goes to that node."
;;;###autoload ;;;###autoload
(defun ediff-merge-directories-with-ancestor-command () (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)) (let ((file-a (nth 0 command-line-args-left))
(file-b (nth 1 command-line-args-left)) (file-b (nth 1 command-line-args-left))
(ancestor (nth 2 command-line-args-left)) (ancestor (nth 2 command-line-args-left))

View 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)) (vc-annotate-show-diff-revision-at-line-internal t))
(defun vc-annotate-show-changeset-diff-revision-at-line () (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) (interactive)
(when (eq 'file (vc-call-backend vc-annotate-backend 'revision-granularity)) (when (eq 'file (vc-call-backend vc-annotate-backend 'revision-granularity))
(error "The %s backend does not support changeset diffs" vc-annotate-backend)) (error "The %s backend does not support changeset diffs" vc-annotate-backend))

View file

@ -1015,7 +1015,8 @@ child files."
(nreverse result))) (nreverse result)))
(defun vc-dir-child-files-and-states () (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." If it is a file, return the corresponding cons for the file itself."
(let* ((crt (ewoc-locate vc-ewoc)) (let* ((crt (ewoc-locate vc-ewoc))
(crt-data (ewoc-data crt)) (crt-data (ewoc-data crt))

View file

@ -404,7 +404,7 @@ Display the buffer in some window, but don't select it."
(defvar compilation-error-regexp-alist) (defvar compilation-error-regexp-alist)
(defun vc-compilation-mode (backend) (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) (require 'compile)
(let* ((error-regexp-alist (let* ((error-regexp-alist
(vc-make-backend-sym backend 'error-regexp-alist)) (vc-make-backend-sym backend 'error-regexp-alist))

View file

@ -2624,7 +2624,7 @@ with its diffs (if the underlying VCS supports that)."
;;;###autoload ;;;###autoload
(defun vc-log-incoming (&optional remote-location) (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." When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
(interactive (interactive
(when current-prefix-arg (when current-prefix-arg
@ -2637,7 +2637,7 @@ When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
;;;###autoload ;;;###autoload
(defun vc-log-outgoing (&optional remote-location) (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." When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
(interactive (interactive
(when current-prefix-arg (when current-prefix-arg

View file

@ -2193,8 +2193,8 @@ resultant list will be returned."
limit t)) limit t))
(defun whitespace-empty-at-bob-regexp (limit) (defun whitespace-empty-at-bob-regexp (limit)
"Match spaces at beginning of buffer which do not contain the point at \ "Match spaces at beginning of buffer which do not contain
beginning of buffer." the point at beginning of buffer."
(let ((b (point)) (let ((b (point))
r) r)
(cond (cond

View 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) (defun auth-source-pass--explain-match-entry-p (entry hostname &optional user port)
"Explainer function for `auth-source-pass-match-entry-p'. "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
,entry ,entry
store 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) (defun auth-source-pass--explain-includes-sorted-entries (entries hostname &optional user port)
"Explainer function for `auth-source-pass--includes-sorted-entries'. "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 `(store
,(auth-source-pass-entries) ,(auth-source-pass-entries)
matching-entries matching-entries

View file

@ -123,9 +123,9 @@ The following invariants must be true for all conformant implementations..."
(defsubst ucs-normalize-tests--rule2-holds-p (X) (defsubst ucs-normalize-tests--rule2-holds-p (X)
"Check 2nd conformance rule. "Check 2nd conformance rule.
For every code point X assigned in this version of Unicode that is not specifically For every code point X assigned in this version of Unicode that
listed in Part 1, the following invariants must be true for all conformant is not specifically listed in Part 1, the following invariants
implementations: must be true for all conformant implementations:
X == toNFC(X) == toNFD(X) == toNFKC(X) == toNFKD(X)" X == toNFC(X) == toNFD(X) == toNFKC(X) == toNFKD(X)"
(and (ucs-normalize-tests--normalization-chareq-p NFC X X) (and (ucs-normalize-tests--normalization-chareq-p NFC X X)