[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
feature/rcirc-update fb27708 5/5: Fix checkdoc issues
From: |
Philip Kaludercic |
Subject: |
feature/rcirc-update fb27708 5/5: Fix checkdoc issues |
Date: |
Tue, 27 Jul 2021 11:42:46 -0400 (EDT) |
branch: feature/rcirc-update
commit fb27708f51fb0fd60cd00cd8ea7bfc9248eb0040
Author: Philip Kaludercic <philipk@posteo.net>
Commit: Philip Kaludercic <philipk@posteo.net>
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 2c8bf43..559f579 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)