From fb27708f51fb0fd60cd00cd8ea7bfc9248eb0040 Mon Sep 17 00:00:00 2001 From: Philip Kaludercic Date: Tue, 27 Jul 2021 17:42:32 +0200 Subject: [PATCH] Fix checkdoc issues * rcirc.el (rcirc-finished-sasl): Add period. (rcirc-mode): Expand docstring. (rcirc-handler-900): Document sender and process --- lisp/net/rcirc.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index 2c8bf431db6..559f579c0a1 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -608,7 +608,7 @@ See `rcirc-connect' for more details on these variables.") (defvar-local rcirc-acked-capabilities nil "A list of capabilities that the server supports.") (defvar-local rcirc-finished-sasl t - "Check whether SASL authentication has completed") + "Check whether SASL authentication has completed.") (defun rcirc-get-server-method (server) "Return authentication method for SERVER." @@ -1255,7 +1255,8 @@ Each element looks like (FILENAME . TEXT).") This number is independent of the number of lines in the buffer.") (defun rcirc-mode (process target) - "Major mode for IRC channel buffers. + "Initialize an IRC buffer for writing with TARGET. +PROCESS is the process object used for communication. \\{rcirc-mode-map}" ;; FIXME: Use define-derived-mode. @@ -3526,7 +3527,9 @@ PROCESS is the process object for the current connection." "\0" (rcirc-get-server-password rcirc-server))))) (defun rcirc-handler-900 (process sender args _text) - "Respond to a successful authentication response." + "Respond to a successful authentication response. +SENDER is passed on to `rcirc-handler-generic'. PROCESS is the +process object for the current connection." (rcirc-handler-generic process "900" sender args nil) (when (not rcirc-finished-sasl) (setq-local rcirc-finished-sasl t) -- 2.39.5