From 8772d81966f0b1cec400fd638c5ab809cae91df4 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sun, 19 Sep 2021 13:21:56 +0200 Subject: [PATCH] ; Some more docfixes for erc/*.el --- lisp/erc/erc-autoaway.el | 3 +-- lisp/erc/erc-backend.el | 4 ++-- lisp/erc/erc-dcc.el | 11 ++++++----- lisp/erc/erc.el | 5 ++--- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/lisp/erc/erc-autoaway.el b/lisp/erc/erc-autoaway.el index 857a6864547..f7de61ce797 100644 --- a/lisp/erc/erc-autoaway.el +++ b/lisp/erc/erc-autoaway.el @@ -227,8 +227,7 @@ NONE-ALIVE-FUNC is the function to call if no ERC processes are alive." (when none-alive-func (funcall none-alive-func))))) (defun erc-autoaway-some-open-server-buffer () - "Return some ERC server buffer if its connection is alive and the -user is not away. + "Return some ERC server buffer if its connection is alive and user is not away. If none is found, return nil." (car (erc-buffer-list (lambda () (and (erc-open-server-buffer-p) diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 4040a7bcae6..10be2965ad7 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -444,7 +444,7 @@ Currently this is called by `erc-send-input'." (defun erc-forward-word () "Move forward one word, ignoring any subword settings. -If no subword-mode is active, then this is (forward-word)." +If no `subword-mode' is active, then this is (forward-word)." (skip-syntax-forward "^w") (> (skip-syntax-forward "w") 0)) @@ -458,7 +458,7 @@ If POS is out of range, the value is nil." (defun erc-bounds-of-word-at-point () "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 +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)))) diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index 60c722843b1..147b90291ad 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -81,7 +81,8 @@ IRC users." All values of the list must be uppercase strings.") (defvar erc-dcc-list nil - "List of DCC connections. Looks like: + "List of DCC connections. +Looks like: ((:nick \"nick!user@host\" :type GET :peer proc :parent proc :size size :file file) (:nick \"nick!user@host\" :type CHAT :peer proc :parent proc) @@ -163,8 +164,9 @@ All values of the list must be uppercase strings.") ;;; Misc macros and utility functions (defun erc-dcc-member (&rest args) - "Return the first matching entry in `erc-dcc-list' which satisfies the -constraints given as a plist in ARGS. Returns nil on no match. + "Return first matching entry in `erc-dcc-list' satisfying constraints in plist ARGS. + +Return nil on no match. The property :nick is treated specially, if it contains a `!' character, it is treated as a nick!user@host string, and compared with the :nick property @@ -205,8 +207,7 @@ compared with `erc-nick-equal-p' which is IRC case-insensitive." result)) (defun erc-pack-int (value) - "Convert an integer into a packed string in network byte order, -which is big-endian." + "Convert integer into a packed string in network byte order, which is big-endian." ;; make sure value is not negative (when (< value 0) (error "ERC-DCC (erc-pack-int): packet size is negative")) diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index be0c411e62f..ac0c08bd3a2 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -2720,9 +2720,8 @@ displayed hostnames." :type 'alist) (defun erc-canonicalize-server-name (server) - "Return the canonical network name for SERVER if any, -otherwise `erc-server-announced-name'. SERVER is matched against -`erc-common-server-suffixes'." + "Return canonical network name for SERVER or `erc-server-announced-name'. +SERVER is matched against `erc-common-server-suffixes'." (when server (or (cdar (cl-remove-if-not (lambda (net) (string-match (car net) server)) -- 2.39.5