aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/erc
diff options
context:
space:
mode:
authorJuanma Barranquero2019-10-20 12:12:27 +0200
committerJuanma Barranquero2019-10-20 12:12:27 +0200
commit41ba8231ef072571e1a6feabc15d113e5cf57556 (patch)
treeebfb9888ed6f62295fac4a0c7858f6881ffda491 /lisp/erc
parente2acf4d29d6f03c7b8c6fbeb61ed1f4a6ef5b1fd (diff)
downloademacs-41ba8231ef072571e1a6feabc15d113e5cf57556.tar.gz
emacs-41ba8231ef072571e1a6feabc15d113e5cf57556.zip
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.
Diffstat (limited to 'lisp/erc')
-rw-r--r--lisp/erc/erc-backend.el21
-rw-r--r--lisp/erc/erc-dcc.el17
-rw-r--r--lisp/erc/erc-log.el2
-rw-r--r--lisp/erc/erc-networks.el8
-rw-r--r--lisp/erc/erc-pcomplete.el16
5 files changed, 33 insertions, 31 deletions
diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el
index 3250d0fdfde..72a7f86da2f 100644
--- a/lisp/erc/erc-backend.el
+++ b/lisp/erc/erc-backend.el
@@ -481,13 +481,13 @@ Currently this is called by `erc-send-input'."
481 (split-string (buffer-string) "\n")))) 481 (split-string (buffer-string) "\n"))))
482 482
483(defun erc-forward-word () 483(defun erc-forward-word ()
484 "Moves forward one word, ignoring any subword settings. If no 484 "Move forward one word, ignoring any subword settings.
485subword-mode is active, then this is (forward-word)." 485If no subword-mode is active, then this is (forward-word)."
486 (skip-syntax-forward "^w") 486 (skip-syntax-forward "^w")
487 (> (skip-syntax-forward "w") 0)) 487 (> (skip-syntax-forward "w") 0))
488 488
489(defun erc-word-at-arg-p (pos) 489(defun erc-word-at-arg-p (pos)
490 "Reports whether the char after a given POS has word syntax. 490 "Report whether the char after a given POS has word syntax.
491If POS is out of range, the value is nil." 491If POS is out of range, the value is nil."
492 (let ((c (char-after pos))) 492 (let ((c (char-after pos)))
493 (if c 493 (if c
@@ -495,9 +495,9 @@ If POS is out of range, the value is nil."
495 nil))) 495 nil)))
496 496
497(defun erc-bounds-of-word-at-point () 497(defun erc-bounds-of-word-at-point ()
498 "Returns the bounds of a word at point, or nil if we're not at 498 "Return the bounds of word at point, or nil if we're not at a word.
499a word. If no subword-mode is active, then this 499If no subword-mode is active, then this is
500is (bounds-of-thing-at-point 'word)." 500\(bounds-of-thing-at-point 'word)."
501 (if (or (erc-word-at-arg-p (point)) 501 (if (or (erc-word-at-arg-p (point))
502 (erc-word-at-arg-p (1- (point)))) 502 (erc-word-at-arg-p (1- (point))))
503 (save-excursion 503 (save-excursion
@@ -596,7 +596,7 @@ We will store server variables in the buffer given by BUFFER."
596 (erc-login)) )) 596 (erc-login)) ))
597 597
598(defun erc-server-reconnect () 598(defun erc-server-reconnect ()
599"Reestablish the current IRC connection. 599 "Reestablish the current IRC connection.
600Make sure you are in an ERC buffer when running this." 600Make sure you are in an ERC buffer when running this."
601 (let ((buffer (erc-server-buffer))) 601 (let ((buffer (erc-server-buffer)))
602 (unless (buffer-live-p buffer) 602 (unless (buffer-live-p buffer)
@@ -765,8 +765,8 @@ This is determined via `erc-encoding-coding-alist' or
765 765
766(defun erc-decode-string-from-target (str target) 766(defun erc-decode-string-from-target (str target)
767 "Decode STR as appropriate for TARGET. 767 "Decode STR as appropriate for TARGET.
768This is indicated by `erc-encoding-coding-alist', defaulting to the value of 768This is indicated by `erc-encoding-coding-alist', defaulting to the
769`erc-server-coding-system'." 769value of `erc-server-coding-system'."
770 (unless (stringp str) 770 (unless (stringp str)
771 (setq str "")) 771 (setq str ""))
772 (let ((coding (erc-coding-system-for-target target))) 772 (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
1118meanings). 1118meanings).
1119 1119
1120This creates: 1120This creates:
1121 - a hook variable `erc-server-NAME-functions' initialized to `erc-server-NAME'. 1121 - a hook variable `erc-server-NAME-functions' initialized to
1122 `erc-server-NAME'.
1122 - a function `erc-server-NAME' with body FN-BODY. 1123 - a function `erc-server-NAME' with body FN-BODY.
1123 1124
1124If ALIASES is non-nil, each alias in ALIASES is `defalias'ed to 1125If ALIASES is non-nil, each alias in ALIASES is `defalias'ed to
diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el
index f8bd5bf3083..899fa5d0fed 100644
--- a/lisp/erc/erc-dcc.el
+++ b/lisp/erc/erc-dcc.el
@@ -309,7 +309,7 @@ Should be set to a string or nil. If nil, use the value of
309 :type '(choice (const ask) (const auto) (const ignore))) 309 :type '(choice (const ask) (const auto) (const ignore)))
310 310
311(defun erc-dcc-get-host (proc) 311(defun erc-dcc-get-host (proc)
312 "Returns the local IP address used for an open PROCess." 312 "Return the local IP address used for an open process PROC."
313 (format-network-address (process-contact proc :local) t)) 313 (format-network-address (process-contact proc :local) t))
314 314
315(defun erc-dcc-host () 315(defun erc-dcc-host ()
@@ -413,7 +413,7 @@ where FOO is one of CLOSE, GET, SEND, LIST, CHAT, etc."
413 413
414;;;###autoload 414;;;###autoload
415(defun pcomplete/erc-mode/DCC () 415(defun pcomplete/erc-mode/DCC ()
416 "Provides completion for the /DCC command." 416 "Provide completion for the /DCC command."
417 (pcomplete-here (append '("chat" "close" "get" "list") 417 (pcomplete-here (append '("chat" "close" "get" "list")
418 (when (fboundp 'make-network-process) '("send")))) 418 (when (fboundp 'make-network-process) '("send"))))
419 (pcomplete-here 419 (pcomplete-here
@@ -685,9 +685,10 @@ It extracts the information about the dcc request and adds it to
685 ?n nick ?u login ?h host ?q query))))) 685 ?n nick ?u login ?h host ?q query)))))
686 686
687(defun erc-dcc-auto-mask-p (spec) 687(defun erc-dcc-auto-mask-p (spec)
688 "Takes a full SPEC of a user in the form \"nick!login@host\" and 688 "Match SPEC against `erc-dcc-auto-masks'.
689matches against all the regexp's in `erc-dcc-auto-masks'. If any 689SPEC is a full spec of a user in the form \"nick!login@host\", which
690match, returns that regexp and nil otherwise." 690is matched against all the regexps in `erc-dcc-auto-masks'. Return
691the matching regexp, or nil if none found."
691 (let ((lst erc-dcc-auto-masks)) 692 (let ((lst erc-dcc-auto-masks))
692 (while (and lst 693 (while (and lst
693 (not (string-match (car lst) spec))) 694 (not (string-match (car lst) spec)))
@@ -907,9 +908,9 @@ other client."
907(make-variable-buffer-local 'erc-dcc-file-name) 908(make-variable-buffer-local 'erc-dcc-file-name)
908 909
909(defun erc-dcc-get-file (entry file parent-proc) 910(defun erc-dcc-get-file (entry file parent-proc)
910 "This function does the work of setting up a transfer from the remote client 911 "Set up a transfer from the remote client to the local over a TCP connection.
911to the local one over a tcp connection. This involves setting up a process 912This involves setting up a process filter and a process sentinel,
912filter and a process sentinel, and making the connection." 913and making the connection."
913 (let* ((buffer (generate-new-buffer (file-name-nondirectory file))) 914 (let* ((buffer (generate-new-buffer (file-name-nondirectory file)))
914 proc) 915 proc)
915 (with-current-buffer buffer 916 (with-current-buffer buffer
diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el
index d6763c01f36..b9bf40d6fab 100644
--- a/lisp/erc/erc-log.el
+++ b/lisp/erc/erc-log.el
@@ -283,7 +283,7 @@ The current buffer is given by BUFFER."
283 erc-enable-logging nil)))) 283 erc-enable-logging nil))))
284 284
285(defun erc-log-all-but-server-buffers (buffer) 285(defun erc-log-all-but-server-buffers (buffer)
286 "Returns t if logging should be enabled in BUFFER. 286 "Return t if logging should be enabled in BUFFER.
287Returns nil if `erc-server-buffer-p' returns t." 287Returns nil if `erc-server-buffer-p' returns t."
288 (save-excursion 288 (save-excursion
289 (save-window-excursion 289 (save-window-excursion
diff --git a/lisp/erc/erc-networks.el b/lisp/erc/erc-networks.el
index 352f714491f..dbd0e1da893 100644
--- a/lisp/erc/erc-networks.el
+++ b/lisp/erc/erc-networks.el
@@ -730,9 +730,9 @@ MATCHER is used to find a corresponding network to a server while
730 730
731;;;###autoload 731;;;###autoload
732(defun erc-determine-network () 732(defun erc-determine-network ()
733 "Return the name of the network or \"Unknown\" as a symbol. Use the 733 "Return the name of the network or \"Unknown\" as a symbol.
734server parameter NETWORK if provided, otherwise parse the server name and 734Use the server parameter NETWORK if provided, otherwise parse the
735search for a match in `erc-networks-alist'." 735server name and search for a match in `erc-networks-alist'."
736 ;; The server made it easy for us and told us the name of the NETWORK 736 ;; The server made it easy for us and told us the name of the NETWORK
737 (let ((network-name (cdr (assoc "NETWORK" erc-server-parameters)))) 737 (let ((network-name (cdr (assoc "NETWORK" erc-server-parameters))))
738 (if network-name 738 (if network-name
@@ -760,7 +760,7 @@ Return the name of this server's network as a symbol."
760 "Obsolete since erc-networks 1.5") 760 "Obsolete since erc-networks 1.5")
761 761
762(defun erc-network-name () 762(defun erc-network-name ()
763 "Returns the name of the current network as a string." 763 "Return the name of the current network as a string."
764 (erc-with-server-buffer (symbol-name erc-network))) 764 (erc-with-server-buffer (symbol-name erc-network)))
765 765
766(defun erc-set-network-name (proc parsed) 766(defun erc-set-network-name (proc parsed)
diff --git a/lisp/erc/erc-pcomplete.el b/lisp/erc/erc-pcomplete.el
index 55405498f1e..fe01e1d76e6 100644
--- a/lisp/erc/erc-pcomplete.el
+++ b/lisp/erc/erc-pcomplete.el
@@ -188,14 +188,14 @@ for use on `completion-at-point-function'."
188;;; Functions that provide possible completions. 188;;; Functions that provide possible completions.
189 189
190(defun pcomplete-erc-commands () 190(defun pcomplete-erc-commands ()
191 "Returns a list of strings of the defined user commands." 191 "Return a list of strings of the defined user commands."
192 (let ((case-fold-search nil)) 192 (let ((case-fold-search nil))
193 (mapcar (lambda (x) 193 (mapcar (lambda (x)
194 (concat "/" (downcase (substring (symbol-name x) 8)))) 194 (concat "/" (downcase (substring (symbol-name x) 8))))
195 (apropos-internal "erc-cmd-[A-Z]+")))) 195 (apropos-internal "erc-cmd-[A-Z]+"))))
196 196
197(defun pcomplete-erc-ops () 197(defun pcomplete-erc-ops ()
198 "Returns a list of nicks with ops." 198 "Return a list of nicks with ops."
199 (let (ops) 199 (let (ops)
200 (maphash (lambda (nick cdata) 200 (maphash (lambda (nick cdata)
201 (if (and (cdr cdata) 201 (if (and (cdr cdata)
@@ -205,7 +205,7 @@ for use on `completion-at-point-function'."
205 ops)) 205 ops))
206 206
207(defun pcomplete-erc-not-ops () 207(defun pcomplete-erc-not-ops ()
208 "Returns a list of nicks without ops." 208 "Return a list of nicks without ops."
209 (let (not-ops) 209 (let (not-ops)
210 (maphash (lambda (nick cdata) 210 (maphash (lambda (nick cdata)
211 (if (and (cdr cdata) 211 (if (and (cdr cdata)
@@ -216,7 +216,7 @@ for use on `completion-at-point-function'."
216 216
217 217
218(defun pcomplete-erc-nicks (&optional postfix ignore-self) 218(defun pcomplete-erc-nicks (&optional postfix ignore-self)
219 "Returns a list of nicks in the current channel. 219 "Return a list of nicks in the current channel.
220Optional argument POSTFIX is something to append to the nickname. 220Optional argument POSTFIX is something to append to the nickname.
221If optional argument IGNORE-SELF is non-nil, don't return the current nick." 221If optional argument IGNORE-SELF is non-nil, don't return the current nick."
222 (let ((users (if erc-pcomplete-order-nickname-completions 222 (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."
235 (nreverse nicks))) 235 (nreverse nicks)))
236 236
237(defun pcomplete-erc-all-nicks (&optional postfix) 237(defun pcomplete-erc-all-nicks (&optional postfix)
238 "Returns a list of all nicks on the current server." 238 "Return a list of all nicks on the current server."
239 (let (nicks) 239 (let (nicks)
240 (erc-with-server-buffer 240 (erc-with-server-buffer
241 (maphash (lambda (_nick user) 241 (maphash (lambda (_nick user)
@@ -246,20 +246,20 @@ If optional argument IGNORE-SELF is non-nil, don't return the current nick."
246 nicks)) 246 nicks))
247 247
248(defun pcomplete-erc-channels () 248(defun pcomplete-erc-channels ()
249 "Returns a list of channels associated with the current server." 249 "Return a list of channels associated with the current server."
250 (mapcar (lambda (buf) (with-current-buffer buf (erc-default-target))) 250 (mapcar (lambda (buf) (with-current-buffer buf (erc-default-target)))
251 (erc-channel-list erc-server-process))) 251 (erc-channel-list erc-server-process)))
252 252
253;;; Functions for parsing 253;;; Functions for parsing
254 254
255(defun pcomplete-erc-command-name () 255(defun pcomplete-erc-command-name ()
256 "Returns the command name of the first argument." 256 "Return the command name of the first argument."
257 (if (eq (elt (pcomplete-arg 'first) 0) ?/) 257 (if (eq (elt (pcomplete-arg 'first) 0) ?/)
258 (upcase (substring (pcomplete-arg 'first) 1)) 258 (upcase (substring (pcomplete-arg 'first) 1))
259 "SAY")) 259 "SAY"))
260 260
261(defun pcomplete-erc-parse-arguments () 261(defun pcomplete-erc-parse-arguments ()
262 "Returns a list of parsed whitespace-separated arguments. 262 "Return a list of parsed whitespace-separated arguments.
263These are the words from the beginning of the line after the prompt 263These are the words from the beginning of the line after the prompt
264up to where point is right now." 264up to where point is right now."
265 (let* ((start erc-input-marker) 265 (let* ((start erc-input-marker)