diff options
Diffstat (limited to 'lisp/erc')
-rw-r--r-- | lisp/erc/erc-backend.el | 21 | ||||
-rw-r--r-- | lisp/erc/erc-dcc.el | 17 | ||||
-rw-r--r-- | lisp/erc/erc-log.el | 2 | ||||
-rw-r--r-- | lisp/erc/erc-networks.el | 8 | ||||
-rw-r--r-- | lisp/erc/erc-pcomplete.el | 16 |
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'." (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 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 :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 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." 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 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 ;;;###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) 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'." ;;; 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) |