Commit 41ba8231 authored by Juanma Barranquero's avatar Juanma Barranquero

lisp/*.el: Fix typos and improve some docstrings

* lisp/auth-source.el (auth-source-backend-parse-parameters)
(auth-source-search-collection)
(auth-source-secrets-listify-pattern)
(auth-source--decode-octal-string, auth-source-plstore-search):
* lisp/registry.el (registry-lookup)
(registry-lookup-breaks-before-lexbind)
(registry-lookup-secondary, registry-lookup-secondary-value)
(registry-search, registry-delete, registry-size, registry-full)
(registry-insert, registry-reindex, registry-prune)
(registry-collect-prune-candidates):
* lisp/subr.el (nbutlast, process-live-p):
* lisp/tab-bar.el (tab-bar-list):
* lisp/cedet/ede/linux.el (ede-linux--get-archs)
(ede-linux--include-path, ede-linux-load):
* lisp/erc/erc-log.el (erc-log-all-but-server-buffers):
* lisp/erc/erc-pcomplete.el (pcomplete-erc-commands)
(pcomplete-erc-ops, pcomplete-erc-not-ops, pcomplete-erc-nicks)
(pcomplete-erc-all-nicks, pcomplete-erc-channels)
(pcomplete-erc-command-name, pcomplete-erc-parse-arguments):
* lisp/eshell/em-term.el (eshell-visual-command-p):
* lisp/gnus/gnus-cache.el (gnus-cache-fully-p):
* lisp/gnus/nnmail.el (nnmail-get-active)
(nnmail-fancy-expiry-target):
* lisp/mail/mail-utils.el (mail-string-delete):
* lisp/mail/supercite.el (sc-hdr, sc-valid-index-p):
* lisp/net/ange-ftp.el (ange-ftp-use-smart-gateway-p):
* lisp/net/nsm.el (nsm-save-fingerprint-maybe)
(nsm-network-same-subnet, nsm-should-check):
* lisp/net/rcirc.el (rcirc-looking-at-input):
* lisp/net/tramp-cache.el (tramp-get-hash-table):
* lisp/net/tramp-compat.el (tramp-compat-process-running-p):
* lisp/net/tramp-smb.el (tramp-smb-get-share)
(tramp-smb-get-localname, tramp-smb-read-file-entry)
(tramp-smb-get-cifs-capabilities, tramp-smb-get-stat-capability):
* lisp/net/zeroconf.el (zeroconf-list-service-names)
(zeroconf-list-service-types, zeroconf-list-services)
(zeroconf-get-host, zeroconf-get-domain)
(zeroconf-get-host-domain):
* lisp/nxml/rng-xsd.el (rng-xsd-compile)
(rng-xsd-make-date-time-regexp, rng-xsd-convert-date-time):
* lisp/obsolete/erc-hecomplete.el (erc-hecomplete)
(erc-command-list, erc-complete-at-prompt):
* lisp/org/ob-scheme.el (org-babel-scheme-get-buffer-impl):
* lisp/org/ob-shell.el (org-babel--variable-assignments:sh-generic)
(org-babel--variable-assignments:bash_array)
(org-babel--variable-assignments:bash_assoc)
(org-babel--variable-assignments:bash):
* lisp/org/org-clock.el (org-day-of-week):
* lisp/progmodes/cperl-mode.el (cperl-char-ends-sub-keyword-p):
* lisp/progmodes/gud.el (gud-find-c-expr, gud-innermost-expr)
(gud-prev-expr, gud-next-expr):
* lisp/textmodes/table.el (table--at-cell-p, table--probe-cell)
(table--get-cell-justify-property)
(table--get-cell-valign-property)
(table--put-cell-justify-property)
(table--put-cell-valign-property): Fix typos.

* lisp/so-long.el (fboundp): Doc fix.
(so-long-mode-line-info, so-long-mode)
(so-long--check-header-modes): Fix typos.

* lisp/emulation/viper-mous.el (viper-surrounding-word)
(viper-mouse-click-get-word): Fix typos.
(viper-mouse-click-search-word): Doc fix.

* lisp/erc/erc-backend.el (erc-forward-word, erc-word-at-arg-p)
(erc-bounds-of-word-at-point): Fix typos.
(erc-decode-string-from-target, define-erc-response-handler):
Refill docstring.

* lisp/erc/erc-dcc.el (pcomplete/erc-mode/DCC): Fix typo.
(erc-dcc-get-host, erc-dcc-auto-mask-p, erc-dcc-get-file):
Doc fixes.

* lisp/erc/erc-networks.el (erc-network-name): Fix typo.
(erc-determine-network): Refill docstring.

* lisp/net/dbus.el (dbus-list-hash-table)
(dbus-string-to-byte-array, dbus-byte-array-to-string)
(dbus-check-event): Fix typos.
(dbus-introspect-get-property): Doc fix.

* lisp/net/tramp-adb.el (tramp-adb-file-name-handler):
Rename ARGS to ARGUMENTS.  Doc fix.
(tramp-adb-sh-fix-ls-output, tramp-adb-execute-adb-command)
(tramp-adb-find-test-command): Fix typos.

* lisp/net/tramp.el (tramp-set-completion-function)
(tramp-get-completion-function)
(tramp-completion-dissect-file-name)
(tramp-completion-dissect-file-name1)
(tramp-get-completion-methods, tramp-get-completion-user-host)
(tramp-get-inode, tramp-get-device, tramp-mode-string-to-int)
(tramp-call-process, tramp-call-process-region)
(tramp-process-lines): Fix typos.
(tramp-interrupt-process): Doc fix.

* lisp/org/ob-core.el (org-babel-named-src-block-regexp-for-name)
(org-babel-named-data-regexp-for-name): Doc fix.
(org-babel-src-block-names, org-babel-result-names): Fix typos.

* lisp/progmodes/inf-lisp.el (lisp-input-filter): Doc fix.
(lisp-fn-called-at-pt): Fix typo.

* lisp/progmodes/xref.el (xref-backend-identifier-at-point):
Doc fix.
(xref-backend-identifier-completion-table): Fix typo.
parent e2acf4d2
......@@ -4970,7 +4970,7 @@
* msdos/sed1v2.inp: Adapt to Emacs 25.
* src/process.c (remove_slash_colon): Move out of "#ifdef
subprocesses" block, as it its called unconditionally. Move
subprocesses" block, as it is called unconditionally. Move
ADD_SUBFEATURE calls into "#ifdef subprocesses" block, as they
reference variables only defined in that block.
* src/msdos.h: Provide prototypes for IT_set_frame_parameters,
......@@ -17774,7 +17774,7 @@
2015-11-08 Dmitry Gutov <dgutov@yandex.ru>
Remove dirs in vc project roots from the the vc project library roots
Remove dirs in vc project roots from the vc project library roots
* lisp/progmodes/project.el (project-library-roots):
Remove directories inside the project roots from the result.
......@@ -1037,7 +1037,7 @@
If there are directory entries in the list then they are sorted in
order of name length. The list of modes for that dir is then
recursively sorted with the same mechanism. That way variables tied
to a particular subdirectory override those in in a parent directory.
to a particular subdirectory override those in a parent directory.
Previously the behaviour didn’t seem to be well defined anyway and was
dependent on the order they appeared in the file. However this order
......@@ -8841,7 +8841,7 @@
If grow_specpdl fails due to outgrowing max_specpdl_size, it will
signal an error *before* growing the specpdl array. Therefore, when
handling the signal, specpdl_ptr points past the end of the specpdl
array and any further use of of specpdl before unwinding (e.g., if
array and any further use of specpdl before unwinding (e.g., if
edebug binds signal-hook-function) will cause memory corruption.
* src/eval.c (signal_or_quit): Don't call `signal-hook-function' if
the specpdl_ptr is already past the end of the specpdl array.
......@@ -12008,7 +12008,7 @@
Improve edit-kbd-macro prompting in case of remapped keys (Bug#29399)
* lisp/edmacro.el (edit-kbd-macro): Use substitute-command-keys to
present the current bindings in the prompt. Check the the
present the current bindings in the prompt. Check the
non-remapped binding of the entered key sequence as well.
2017-12-02 Lele Gaifax <lele@metapensiero.it>
......@@ -24195,7 +24195,7 @@
Optimize UCS normalization tests
Brings the the time for `ucs-normalize-part1' from 200s down to 130s.
Brings the time for `ucs-normalize-part1' from 200s down to 130s.
* test/lisp/international/ucs-normalize-tests.el
(ucs-normalize-tests--parse-column): Use character instead of string
of length 1 for terminator. Convert return value into string since
......@@ -63687,7 +63687,7 @@
2016-01-29 Lars Ingebrigtsen <larsi@gnus.org>
Compilation for for systems with getaddrinfo_a
Compilation for systems with getaddrinfo_a
* src/process.c (Fmake_network_process): Make stuff work again on
systems with getaddrinfo_a.
......@@ -63701,7 +63701,7 @@
2016-01-29 Lars Ingebrigtsen <larsi@gnus.org>
Compilation for for non-GNU systems
Compilation for non-GNU systems
* src/process.c (Fmake_network_process): Make compilation work
again on hosts that don't have getaddrinfo_a.
......@@ -4632,7 +4632,7 @@ decoded text.
The decoding functions ignore newline characters in the encoded text.
If optional argument @var{base64url} is is non-@code{nil}, then padding
If optional argument @var{base64url} is non-@code{nil}, then padding
is optional, and the URL variant of base 64 encoding is used.
@end defun
......
......@@ -3754,7 +3754,7 @@ that Calc formulas can operate on them.
**** org-ctags.el (Paul Sexton)
Targets like =<<my target>>= can now be found by Emacs' etag
functionality, and Org-mode links can be used to to link to
functionality, and Org-mode links can be used to link to
etags, also in non-Org-mode files. For details, see the file
/org-ctags.el/.
......
......@@ -4647,7 +4647,7 @@
* vc.el: All backends: API simplification: Remove 4th
'default-state' argument from vc-dir-status files and its backend
methods - no backend method ever set it. It was used only in the
fallback method to to set a default of 'up-to-date, though a
fallback method to set a default of 'up-to-date, though a
convoluted call chain obscured this.
* vc-hooks.el: Bind vc-delete-file to Ctrl-x v delete.
......
......@@ -504,7 +504,7 @@ soon as a function returns non-nil.")
(add-hook 'auth-source-backend-parser-functions #'auth-source-backends-parser-secrets)
(defun auth-source-backend-parse-parameters (entry backend)
"Fills in the extra auth-source-backend parameters of ENTRY.
"Fill in the extra auth-source-backend parameters of ENTRY.
Using the plist ENTRY, get the :host, :port, and :user search
parameters."
(let ((entry (if (stringp entry)
......@@ -773,7 +773,7 @@ Returns the deleted entries."
(apply #'auth-source-search (plist-put spec :delete t)))
(defun auth-source-search-collection (collection value)
"Returns t is VALUE is t or COLLECTION is t or COLLECTION contains VALUE."
"Return t if VALUE is t or COLLECTION is t or COLLECTION contains VALUE."
(when (and (atom collection) (not (eq t collection)))
(setq collection (list collection)))
......@@ -1514,15 +1514,15 @@ Respects `auth-source-save-behavior'. Uses
;;; Backend specific parsing: Secrets API backend
(defun auth-source-secrets-listify-pattern (pattern)
"Convert a pattern with lists to a list of string patterns.
"Convert a PATTERN with lists to a list of string patterns.
auth-source patterns can have values of the form :foo (\"bar\"
\"qux\"), which means to match any secret with :foo equal to
\"bar\" or :foo equal to \"qux\". The secrets backend supports
only string values for patterns, so this routine returns a list
of patterns that is equivalent to the single original pattern
of patterns that is equivalent to the single original PATTERN
when interpreted such that if a secret matches any pattern in the
list, it matches the original pattern."
list, it matches the original PATTERN."
(if (null pattern)
'(nil)
(let* ((key (pop pattern))
......@@ -1935,7 +1935,7 @@ entries for git.gnus.org:
(defun auth-source--decode-octal-string (string)
"Convert octal string to utf-8 string. E.g: 'a\134b' to 'a\b'"
"Convert octal string to utf-8 string. E.g: 'a\134b' to 'a\b'"
(let ((list (string-to-list string))
(size (length string)))
(decode-coding-string
......@@ -2034,7 +2034,7 @@ entries for git.gnus.org:
(cl-defun auth-source-plstore-search (&rest spec
&key backend create delete max
&allow-other-keys)
"Search the PLSTORE; spec is like `auth-source'."
"Search the PLSTORE; SPEC is like `auth-source'."
(let* ((store (oref backend data))
(max (or max 5000)) ; sanity check: default to stop at 5K
(ignored-keys '(:create :delete :max :backend :label :require :type))
......
......@@ -1324,7 +1324,7 @@
(semantic-analyze-tag-references-default): When doing a lookup,
specify noerror.
(semantic--analyze-refs-full-lookup): Add optional noerror input
argument. Pass to to full-lookup-simple.
argument. Pass to full-lookup-simple.
(semantic-analyze-refs-impl, semantic-analyze-refs-proto):
Ignore :typemodifiers during compare.
......
......@@ -118,7 +118,7 @@ If DIR has not been used as a build directory, fall back to
(defun ede-linux--get-archs (dir)
"Returns a list of architecture names found in DIR."
"Return a list of architecture names found in DIR."
(let ((archs-dir (expand-file-name "arch" dir))
archs)
(when (file-directory-p archs-dir)
......@@ -169,7 +169,7 @@ found in DIR."
(defun ede-linux--include-path (dir bdir arch)
"Returns a list with include directories.
"Return a list with include directories.
Returned directories might not exist, since they are not created
until Linux is built for the first time."
(cl-map 'list
......@@ -186,7 +186,7 @@ until Linux is built for the first time."
;;;###autoload
(defun ede-linux-load (dir &optional _rootproj)
"Return an Linux Project object if there is a match.
"Return a Linux Project object if there is a match.
Return nil if there isn't one.
Argument DIR is the directory it is created for.
ROOTPROJ is nil, since there is only one project."
......
......@@ -258,7 +258,7 @@ Return (REGEXP . PRECEDENCE)."
;; -> (any "@" "%" digit "A-Z" space word)
;; -> "[A-Z@%[:digit:][:space:][:word:]]"
;;
;; Problem: If a subpattern is carefully written to to be
;; Problem: If a subpattern is carefully written to be
;; optimisable by regexp-opt, how do we prevent the transforms
;; above from destroying that property?
;; Example: (or "a" (or "abc" "abd" "abe"))
......
......@@ -138,7 +138,7 @@ considered related."
(declare-function viper-forward-char-carefully "viper-cmd" (&optional arg))
(defun viper-surrounding-word (count click-count)
"Returns word surrounding point according to a heuristic.
"Return word surrounding point according to a heuristic.
COUNT indicates how many regions to return.
If CLICK-COUNT is 1, `word' is a word in Vi sense.
If CLICK-COUNT is 2,then `word' is a Word in Vi sense.
......@@ -219,7 +219,7 @@ is ignored."
(defun viper-mouse-click-get-word (click count click-count)
"Returns word surrounding the position of a mouse click.
"Return word surrounding the position of a mouse click.
Click may be in another window. Current window and buffer isn't changed.
On single or double click, returns the word as determined by
`viper-surrounding-word-function'."
......@@ -334,12 +334,13 @@ See `viper-surrounding-word' for the definition of a word in this case."
(declare-function viper-adjust-window "viper-cmd" ())
(defun viper-mouse-click-search-word (click arg)
"Find the word clicked or double-clicked on. Word may be in another window.
"Find the word clicked or double-clicked on. Word may be in another window.
With prefix argument, N, search for N-th occurrence.
This command must be bound to a mouse click. The double-click action of the
same button must not be bound \(or it must be bound to the same function).
See `viper-surrounding-word' for the details on what constitutes a word for
this command."
this command.
\n(fn CLICK N)"
(interactive "e\nP")
(if viper-frame-of-focus ;; to handle clicks in another frame
(select-frame viper-frame-of-focus))
......
......@@ -481,13 +481,13 @@ Currently this is called by `erc-send-input'."
(split-string (buffer-string) "\n"))))
(defun erc-forward-word ()
"Moves forward one word, ignoring any subword settings. If no
subword-mode is active, then this is (forward-word)."
"Move forward one word, ignoring any subword settings.
If no subword-mode is active, then this is (forward-word)."
(skip-syntax-forward "^w")
(> (skip-syntax-forward "w") 0))
(defun erc-word-at-arg-p (pos)
"Reports whether the char after a given POS has word syntax.
"Report whether the char after a given POS has word syntax.
If POS is out of range, the value is nil."
(let ((c (char-after pos)))
(if c
......@@ -495,9 +495,9 @@ If POS is out of range, the value is nil."
nil)))
(defun erc-bounds-of-word-at-point ()
"Returns the bounds of a word at point, or nil if we're not at
a word. If no subword-mode is active, then this
is (bounds-of-thing-at-point 'word)."
"Return the bounds of word at point, or nil if we're not at a word.
If no subword-mode is active, then this is
\(bounds-of-thing-at-point 'word)."
(if (or (erc-word-at-arg-p (point))
(erc-word-at-arg-p (1- (point))))
(save-excursion
......@@ -596,7 +596,7 @@ We will store server variables in the buffer given by BUFFER."
(erc-login)) ))
(defun erc-server-reconnect ()
"Reestablish the current IRC connection.
"Reestablish the current IRC connection.
Make sure you are in an ERC buffer when running this."
(let ((buffer (erc-server-buffer)))
(unless (buffer-live-p buffer)
......@@ -765,8 +765,8 @@ This is determined via `erc-encoding-coding-alist' or
(defun erc-decode-string-from-target (str target)
"Decode STR as appropriate for TARGET.
This is indicated by `erc-encoding-coding-alist', defaulting to the value of
`erc-server-coding-system'."
This is indicated by `erc-encoding-coding-alist', defaulting to the
value of `erc-server-coding-system'."
(unless (stringp str)
(setq str ""))
(let ((coding (erc-coding-system-for-target target)))
......@@ -1118,7 +1118,8 @@ NAME is the response name as sent by the server (see the IRC RFC for
meanings).
This creates:
- a hook variable `erc-server-NAME-functions' initialized to `erc-server-NAME'.
- a hook variable `erc-server-NAME-functions' initialized to
`erc-server-NAME'.
- a function `erc-server-NAME' with body FN-BODY.
If ALIASES is non-nil, each alias in ALIASES is `defalias'ed to
......
......@@ -309,7 +309,7 @@ Should be set to a string or nil. If nil, use the value of
:type '(choice (const ask) (const auto) (const ignore)))
(defun erc-dcc-get-host (proc)
"Returns the local IP address used for an open PROCess."
"Return the local IP address used for an open process PROC."
(format-network-address (process-contact proc :local) t))
(defun erc-dcc-host ()
......@@ -413,7 +413,7 @@ where FOO is one of CLOSE, GET, SEND, LIST, CHAT, etc."
;;;###autoload
(defun pcomplete/erc-mode/DCC ()
"Provides completion for the /DCC command."
"Provide completion for the /DCC command."
(pcomplete-here (append '("chat" "close" "get" "list")
(when (fboundp 'make-network-process) '("send"))))
(pcomplete-here
......@@ -685,9 +685,10 @@ It extracts the information about the dcc request and adds it to
?n nick ?u login ?h host ?q query)))))
(defun erc-dcc-auto-mask-p (spec)
"Takes a full SPEC of a user in the form \"nick!login@host\" and
matches against all the regexp's in `erc-dcc-auto-masks'. If any
match, returns that regexp and nil otherwise."
"Match SPEC against `erc-dcc-auto-masks'.
SPEC is a full spec of a user in the form \"nick!login@host\", which
is matched against all the regexps in `erc-dcc-auto-masks'. Return
the matching regexp, or nil if none found."
(let ((lst erc-dcc-auto-masks))
(while (and lst
(not (string-match (car lst) spec)))
......@@ -907,9 +908,9 @@ other client."
(make-variable-buffer-local 'erc-dcc-file-name)
(defun erc-dcc-get-file (entry file parent-proc)
"This function does the work of setting up a transfer from the remote client
to the local one over a tcp connection. This involves setting up a process
filter and a process sentinel, and making the connection."
"Set up a transfer from the remote client to the local over a TCP connection.
This involves setting up a process filter and a process sentinel,
and making the connection."
(let* ((buffer (generate-new-buffer (file-name-nondirectory file)))
proc)
(with-current-buffer buffer
......
......@@ -283,7 +283,7 @@ The current buffer is given by BUFFER."
erc-enable-logging nil))))
(defun erc-log-all-but-server-buffers (buffer)
"Returns t if logging should be enabled in BUFFER.
"Return t if logging should be enabled in BUFFER.
Returns nil if `erc-server-buffer-p' returns t."
(save-excursion
(save-window-excursion
......
......@@ -730,9 +730,9 @@ MATCHER is used to find a corresponding network to a server while
;;;###autoload
(defun erc-determine-network ()
"Return the name of the network or \"Unknown\" as a symbol. Use the
server parameter NETWORK if provided, otherwise parse the server name and
search for a match in `erc-networks-alist'."
"Return the name of the network or \"Unknown\" as a symbol.
Use the server parameter NETWORK if provided, otherwise parse the
server name and search for a match in `erc-networks-alist'."
;; The server made it easy for us and told us the name of the NETWORK
(let ((network-name (cdr (assoc "NETWORK" erc-server-parameters))))
(if network-name
......@@ -760,7 +760,7 @@ Return the name of this server's network as a symbol."
"Obsolete since erc-networks 1.5")
(defun erc-network-name ()
"Returns the name of the current network as a string."
"Return the name of the current network as a string."
(erc-with-server-buffer (symbol-name erc-network)))
(defun erc-set-network-name (proc parsed)
......
......@@ -188,14 +188,14 @@ for use on `completion-at-point-function'."
;;; Functions that provide possible completions.
(defun pcomplete-erc-commands ()
"Returns a list of strings of the defined user commands."
"Return a list of strings of the defined user commands."
(let ((case-fold-search nil))
(mapcar (lambda (x)
(concat "/" (downcase (substring (symbol-name x) 8))))
(apropos-internal "erc-cmd-[A-Z]+"))))
(defun pcomplete-erc-ops ()
"Returns a list of nicks with ops."
"Return a list of nicks with ops."
(let (ops)
(maphash (lambda (nick cdata)
(if (and (cdr cdata)
......@@ -205,7 +205,7 @@ for use on `completion-at-point-function'."
ops))
(defun pcomplete-erc-not-ops ()
"Returns a list of nicks without ops."
"Return a list of nicks without ops."
(let (not-ops)
(maphash (lambda (nick cdata)
(if (and (cdr cdata)
......@@ -216,7 +216,7 @@ for use on `completion-at-point-function'."
(defun pcomplete-erc-nicks (&optional postfix ignore-self)
"Returns a list of nicks in the current channel.
"Return a list of nicks in the current channel.
Optional argument POSTFIX is something to append to the nickname.
If optional argument IGNORE-SELF is non-nil, don't return the current nick."
(let ((users (if erc-pcomplete-order-nickname-completions
......@@ -235,7 +235,7 @@ If optional argument IGNORE-SELF is non-nil, don't return the current nick."
(nreverse nicks)))
(defun pcomplete-erc-all-nicks (&optional postfix)
"Returns a list of all nicks on the current server."
"Return a list of all nicks on the current server."
(let (nicks)
(erc-with-server-buffer
(maphash (lambda (_nick user)
......@@ -246,20 +246,20 @@ If optional argument IGNORE-SELF is non-nil, don't return the current nick."
nicks))
(defun pcomplete-erc-channels ()
"Returns a list of channels associated with the current server."
"Return a list of channels associated with the current server."
(mapcar (lambda (buf) (with-current-buffer buf (erc-default-target)))
(erc-channel-list erc-server-process)))
;;; Functions for parsing
(defun pcomplete-erc-command-name ()
"Returns the command name of the first argument."
"Return the command name of the first argument."
(if (eq (elt (pcomplete-arg 'first) 0) ?/)
(upcase (substring (pcomplete-arg 'first) 1))
"SAY"))
(defun pcomplete-erc-parse-arguments ()
"Returns a list of parsed whitespace-separated arguments.
"Return a list of parsed whitespace-separated arguments.
These are the words from the beginning of the line after the prompt
up to where point is right now."
(let* ((start erc-input-marker)
......
......@@ -150,7 +150,7 @@ behavior for short-lived processes, see bug#18108."
eshell-interpreter-alist)))
(defun eshell-visual-command-p (command args)
"Returns non-nil when given a visual command.
"Return non-nil when given a visual command.
If either COMMAND or a subcommand in ARGS (e.g. git log) is a
visual command, returns non-nil."
(let ((command (file-name-nondirectory command)))
......
......@@ -732,7 +732,7 @@ If LOW, update the lower bound instead."
(rename-file gnus-cache-directory dir))
(defun gnus-cache-fully-p (&optional group)
"Returns non-nil if the cache should be fully used.
"Return non-nil if the cache should be fully used.
If GROUP is non-nil, also cater to `gnus-cacheable-groups' and
`gnus-uncacheable-groups'."
(and gnus-use-cache
......
......@@ -646,7 +646,7 @@ These will be logged to the \"*nnmail split*\" buffer."
(or file "")))
(defun nnmail-get-active ()
"Returns an assoc of group names and active ranges.
"Return an assoc of group names and active ranges.
nn*-request-list should have been called before calling this function."
;; Go through all groups from the active list.
(with-current-buffer nntp-server-buffer
......@@ -1909,7 +1909,7 @@ If TIME is nil, then return the cutoff time for oldness instead."
(gnus-group-mark-article-read target (cdr group-art))))))))
(defun nnmail-fancy-expiry-target (group)
"Returns a target expiry group determined by `nnmail-fancy-expiry-targets'."
"Return a target expiry group determined by `nnmail-fancy-expiry-targets'."
(let* (header
(case-fold-search nil)
(from (or (message-fetch-field "from") ""))
......
......@@ -56,7 +56,7 @@ also the To field, unless this would leave an empty To field."
(looking-at "BABYL OPTIONS:"))))
(defun mail-string-delete (string start end)
"Returns a string containing all of STRING except the part
"Return a string containing all of STRING except the part
from START (inclusive) to END (exclusive)."
(if (null end) (substring string 0 start)
(concat (substring string 0 start)
......
......@@ -1461,7 +1461,7 @@ First runs `sc-pre-recite-hook'."
;; building headers
(defun sc-hdr (prefix field &optional sep return-nil-p)
"Returns a concatenation of PREFIX and FIELD.
"Return a concatenation of PREFIX and FIELD.
If FIELD is not a string or is the empty string, the empty string will
be returned. Optional third argument SEP is concatenated on the end if
it is a string. Returns empty string, unless optional RETURN-NIL-P is
......@@ -1589,7 +1589,7 @@ Treats these fields in a similar manner to `sc-header-on-said'."
"Current electric reference style.")
(defun sc-valid-index-p (index)
"Returns INDEX if it is a valid index into `sc-rewrite-header-list'.
"Return INDEX if it is a valid index into `sc-rewrite-header-list'.
Otherwise returns nil."
;; a number, and greater than or equal to zero
;; less than or equal to the last index
......
......@@ -1708,7 +1708,7 @@ good, skip, fatal, or unknown."
(not (string-match-p ange-ftp-local-host-regexp host))))
(defun ange-ftp-use-smart-gateway-p (host)
"Returns whether to access this HOST via a smart gateway."
"Return whether to access this HOST via a smart gateway."
(and ange-ftp-smart-gateway
(not (string-match-p ange-ftp-local-host-regexp host))))
......
......@@ -493,7 +493,7 @@ This is an internal function, it shall not be used outside dbus.el."
;;; Hash table of registered functions.
(defun dbus-list-hash-table ()
"Returns all registered member registrations to D-Bus.
"Return all registered member registrations to D-Bus.
The return value is a list, with elements of kind (KEY . VALUE).
See `dbus-registered-objects-table' for a description of the
hash table."
......@@ -888,7 +888,7 @@ association to the service from D-Bus."
;;; D-Bus type conversion.
(defun dbus-string-to-byte-array (string)
"Transforms STRING to list (:array :byte c1 :byte c2 ...).
"Transform STRING to list (:array :byte c1 :byte c2 ...).
STRING shall be UTF8 coded."
(if (zerop (length string))
'(:array :signature "y")
......@@ -897,7 +897,7 @@ STRING shall be UTF8 coded."
(setq result (append result (list :byte elt)))))))
(defun dbus-byte-array-to-string (byte-array &optional multibyte)
"Transforms BYTE-ARRAY into UTF8 coded string.
"Transform BYTE-ARRAY into UTF8 coded string.
BYTE-ARRAY must be a list of structure (c1 c2 ...), or a byte
array as produced by `dbus-string-to-byte-array'. The resulting
string is unibyte encoded, unless MULTIBYTE is non-nil."
......@@ -947,7 +947,7 @@ STRING must have been encoded with `dbus-escape-as-identifier'."
;;; D-Bus events.
(defun dbus-check-event (event)
"Checks whether EVENT is a well formed D-Bus event.
"Check whether EVENT is a well formed D-Bus event.
EVENT is a list which starts with symbol `dbus-event':
(dbus-event BUS TYPE SERIAL SERVICE PATH INTERFACE MEMBER HANDLER &rest ARGS)
......@@ -1319,7 +1319,7 @@ SERVICE is a service of D-Bus BUS at object path PATH."
(push (dbus-introspect-get-attribute elt "name") result))))
(defun dbus-introspect-get-property (bus service path interface property)
"This function returns PROPERTY of INTERFACE as XML object.
"Return PROPERTY of INTERFACE as XML object.
It must be located at SERVICE in D-Bus BUS at object path PATH.
PROPERTY must be a string, element of the list returned by
`dbus-introspect-get-property-names'. The resulting PROPERTY
......
......@@ -179,7 +179,7 @@ See also: `nsm-check-tls-connection', `nsm-save-host-names',
(const :tag "High" high)))))
(defun nsm-save-fingerprint-maybe (host port status &rest _)
"Saves the certificate's fingerprint.
"Save the certificate's fingerprint.
In order to detect man-in-the-middle attacks, when
`network-security-level' is `high', this function will save the
......@@ -199,7 +199,7 @@ RESULTS is an alist where the keys are the checks run and the
values the results of the checks.")
(defun nsm-network-same-subnet (local-ip mask ip)
"Returns t if IP is in the same subnet as LOCAL-IP/MASK.
"Return t if IP is in the same subnet as LOCAL-IP/MASK.
LOCAL-IP, MASK, and IP are specified as vectors of integers, and
are expected to have the same length. Works for both IPv4 and
IPv6 addresses."
......@@ -217,7 +217,7 @@ IPv6 addresses."
matches))
(defun nsm-should-check (host)
"Determines whether NSM should check for TLS problems for HOST.
"Determine whether NSM should check for TLS problems for HOST.
If `nsm-trust-local-network' is or returns non-nil, and if the
host address is a localhost address, or in the same subnet as one
......
......@@ -3063,7 +3063,7 @@ Passwords are stored in `rcirc-authinfo' (which see)."
;; When using M-x flyspell-mode, only check words after the prompt
(put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input)
(defun rcirc-looking-at-input ()
"Returns true if point is past the input marker."
"Return true if point is past the input marker."
(>= (point) rcirc-prompt-end-marker))
......
......@@ -177,14 +177,14 @@ It is used for TCP/IP devices."
tramp-adb-method)))
;;;###tramp-autoload
(defun tramp-adb-file-name-handler (operation &rest args)
(defun tramp-adb-file-name-handler (operation &rest arguments)
"Invoke the ADB handler for OPERATION.
First arg specifies the OPERATION, second arg is a list of arguments to
pass to the OPERATION."
First arg specifies the OPERATION, second arg is a list of
ARGUMENTS to pass to the OPERATION."
(let ((fn (assoc operation tramp-adb-file-name-handler-alist)))
(if fn
(save-match-data (apply (cdr fn) args))
(tramp-run-real-handler operation args))))
(save-match-data (apply (cdr fn) arguments))
(tramp-run-real-handler operation arguments))))
;;;###tramp-autoload
(tramp--with-startup
......@@ -462,7 +462,7 @@ Convert (\"-al\") to (\"-a\" \"-l\"). Remove arguments like \"--dired\"."
(defun tramp-adb-sh-fix-ls-output (&optional sort-by-time)
"Insert dummy 0 in empty size columns.
Androids \"ls\" command doesn't insert size column for directories:
Android's \"ls\" command doesn't insert size column for directories:
Emacs dired can't find files."
(save-excursion
;; Insert missing size.
......@@ -1089,7 +1089,7 @@ E.g. a host name \"192.168.1.1#5555\" returns \"192.168.1.1:5555\"
vec 'file-error "Could not find device %s" host)))))))
(defun tramp-adb-execute-adb-command (vec &rest args)
"Returns nil on success error-output on failure."
"Return nil on success error-output on failure."
(when (and (> (length (tramp-file-name-host vec)) 0)
;; The -s switch is only available for ADB device commands.
(not (member (car args) '("connect" "disconnect"))))
......@@ -1103,7 +1103,7 @@ E.g. a host name \"192.168.1.1#5555\" returns \"192.168.1.1:5555\"
(tramp-message vec 6 "%s" (buffer-string)))))
(defun tramp-adb-find-test-command (vec)
"Checks, whether the ash has a builtin \"test\" command.
"Check whether the ash has a builtin \"test\" command.
This happens for Android >= 4.0."
(with-tramp-connection-property vec "test"
(tramp-adb-send-command-and-check vec "type test")))
......
......@@ -97,7 +97,7 @@ details see the info pages."
"Whether persistent cache data have been changed.")
(defun tramp-get-hash-table (key)
"Returns the hash table for KEY.
"Return the hash table for KEY.
If it doesn't exist yet, it is created and initialized with
matching entries of `tramp-connection-properties'."
(or (gethash key tramp-cache-data)
......
......@@ -75,7 +75,7 @@ Add the extension of F, if existing."
#'tramp-handle-temporary-file-directory))
(defun tramp-compat-process-running-p (process-name)
"Returns t if system process PROCESS-NAME is running for `user-login-name'."
"Return t if system process PROCESS-NAME is running for `user-login-name'."
(when (stringp process-name)
(cond
;; GNU Emacs 22 on w32.
......
......@@ -1577,14 +1577,14 @@ errors for shares like \"C$/\", which are common in Microsoft Windows."
;; Internal file name functions.
(defun tramp-smb-get-share (vec)
"Returns the share name of LOCALNAME."
"Return the share name of LOCALNAME."
(save-match-data
(let ((localname (tramp-file-name-unquote-localname vec)))
(when (string-match "^/?\\([^/]+\\)/" localname)
(match-string 1 localname)))))
(defun tramp-smb-get-localname (vec)
"Returns the file name of LOCALNAME.
"Return the file name of LOCALNAME.
If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"."
(save-match-data
(let ((localname (tramp-file-name-unquote-localname vec)))
......@@ -1717,8 +1717,8 @@ Result is a list of (LOCALNAME MODE SIZE MONTH DAY TIME YEAR)."
;; So we try to analyze backwards.
(defun tramp-smb-read-file-entry (share)
"Parse entry in SMB output buffer.
If SHARE is result, entries are of type dir. Otherwise, shares are listed.
Result is the list (LOCALNAME MODE SIZE MTIME)."
If SHARE is result, entries are of type dir. Otherwise, shares
are listed. Result is the list (LOCALNAME MODE SIZE MTIME)."
;; We are called from `tramp-smb-get-file-entries', which sets the
;; current buffer.
(let ((line (buffer-substring (point) (point-at-eol)))
......@@ -1813,7 +1813,7 @@ Result is the list (LOCALNAME MODE SIZE MTIME)."
(list localname mode size mtime))))
(defun tramp-smb-get-cifs-capabilities (vec)
"Check, whether the SMB server supports POSIX commands."
"Check whether the SMB server supports POSIX commands."
;; When we are not logged in yet, we return nil. The
;; connection-local property "posix" is not set explicitly; it is
;; just checked in order to let a user configure it to nil on hosts
......@@ -1835,7 +1835,7 @@ Result is the list (LOCALNAME MODE SIZE MTIME)."
(buffer-substring (point) (point-at-eol)) nil 'omit)))))))))
(defun tramp-smb-get-stat-capability (vec)
"Check, whether the SMB server supports the STAT command."
"Check whether the SMB server supports the STAT command."
;; When we are not logged in yet, we return nil.
(if (and (tramp-smb-get-share vec)
(process-live-p (tramp-get-connection-process vec)))
......
......@@ -2008,7 +2008,7 @@ letter into the file name. This function removes it."
;;; Config Manipulation Functions:
(defun tramp-set-completion-function (method function-list)
"Sets the list of completion functions for METHOD.
"Set the list of completion functions for METHOD.
FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
The FUNCTION is intended to parse FILE according its syntax.
It might be a predefined FUNCTION, or a user defined FUNCTION.
......@@ -2052,7 +2052,7 @@ Example:
(cons method r)))))
(defun tramp-get-completion-function (method)
"Returns a list of completion functions for METHOD.
"Return a list of completion functions for METHOD.
For definition of that list see `tramp-set-completion-function'."
(append
`(;; Default settings are taken into account.
......@@ -2629,7 +2629,7 @@ not in completion mode."
;; "/x:y@""/[x/y@" "/x:y@z" "/[x/y@z" "/x:y@z:" "/[x/y@z]"
;;["x" "y" nil nil] ["x" "y" "z" nil] ["x" "y" "z" ""]
(defun tramp-completion-dissect-file-name (name)
"Returns a list of `tramp-file-name' structures.
"Return a list of `tramp-file-name' structures.
They are collected by `tramp-completion-dissect-file-name1'."
(let* ((x-nil "\\|\\(\\)")
(tramp-completion-ipv6-regexp
......@@ -2702,7 +2702,7 @@ They are collected by `tramp-completion-dissect-file-name1'."
tramp-completion-file-name-structure6)))))
(defun tramp-completion-dissect-file-name1 (structure name)
"Returns a `tramp-file-name' structure matching STRUCTURE.
"Return a `tramp-file-name' structure matching STRUCTURE.
The structure consists of remote method, remote user,
remote host and localname (filename on remote host)."
(save-match-data
......@@ -2718,7 +2718,7 @@ remote host and localname (filename on remote host)."
;; This function returns all possible method completions, adding the
;; trailing method delimiter.
(defun tramp-get-completion-methods (partial-method)