From 17b3a00c46c1c52169dcdb5d056d9e279d365151 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 8 Jul 2024 16:41:02 +0200 Subject: [PATCH] Checkdoc fixes in `erc/*.el` * lisp/erc/erc-backend.el (erc-server-parameters): * lisp/erc/erc-button.el (erc-button--display-error-with-buttons): * lisp/erc/erc-dcc.el (erc-dcc-member): * lisp/erc/erc-fill.el (erc-fill-wrap-refill-buffer): * lisp/erc/erc-speedbar.el (erc-speedbar--last-ran): * lisp/erc/erc-stamp.el (erc-stamp--current-time): * lisp/erc/erc-track.el (erc-make-mode-line-buffer-name): * lisp/erc/erc.el (erc-interactive-display, erc-modules, erc-cmd-CLEAR) (erc-update-current-channel-member, erc--format-user-modes) (erc-check-text-conversion): Checkdoc fixes. (cherry picked from commit c85f67a66dfc9b3333a466a5fcd313425889ee6e) --- lisp/erc/erc-backend.el | 2 +- lisp/erc/erc-button.el | 2 +- lisp/erc/erc-dcc.el | 2 +- lisp/erc/erc-fill.el | 2 +- lisp/erc/erc-speedbar.el | 2 +- lisp/erc/erc-stamp.el | 4 ++-- lisp/erc/erc-track.el | 2 +- lisp/erc/erc.el | 12 ++++++------ 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 01213c9724d..9aedc110067 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -260,7 +260,7 @@ or where PARAMETER is a string and VALUE is a string or nil. For compatibility, a raw parameter of the form \"FOO=\" becomes (\"FOO\" . \"\") even though it's equivalent to the preferred -canonical form \"FOO\" and its lisp representation (\"FOO\"). +canonical form \"FOO\" and its Lisp representation (\"FOO\"). Some examples of possible parameters sent by servers: CHANMODES=b,k,l,imnpst - list of supported channel modes diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 8cf8991e57c..c158b443b89 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -815,7 +815,7 @@ and `apropos' for other symbols." (defun erc-button--display-error-with-buttons (from to fun nick-p &optional data regexp) - "Replace command in region with keys and return new bounds" + "Replace command in region with keys and return new bounds." (let* ((o (buffer-substring from to)) (s (substitute-command-keys o)) (erc-button-face (and (equal o s) erc-button-face))) diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index b8e16df755b..dec499e727f 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -173,7 +173,7 @@ ARGS is a plist. 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 -value of the individual elements using string-equal. Otherwise it is +value of the individual elements using `string-equal'. Otherwise it is compared with `erc-nick-equal-p' which is IRC case-insensitive." (let ((list erc-dcc-list) result test) diff --git a/lisp/erc/erc-fill.el b/lisp/erc/erc-fill.el index 9d969b39ad2..defef6fe414 100644 --- a/lisp/erc/erc-fill.el +++ b/lisp/erc/erc-fill.el @@ -799,7 +799,7 @@ necessary after revealing previously hidden text with commands like `erc-match-toggle-hidden-fools'." (interactive "P") (unless erc-fill-wrap-mode - (user-error "Module `fill-wrap' not active in current buffer.")) + (user-error "Module `fill-wrap' not active in current buffer")) (save-excursion (with-silent-modifications (let* ((rep (make-progress-reporter diff --git a/lisp/erc/erc-speedbar.el b/lisp/erc/erc-speedbar.el index 3e8c110a31b..e45fb9a7adf 100644 --- a/lisp/erc/erc-speedbar.el +++ b/lisp/erc/erc-speedbar.el @@ -548,7 +548,7 @@ associated with an ERC session." "Speedbar update period.") (defvar-local erc-speedbar--last-ran nil - "When non-nil, a lisp timestamp updated when the speedbar timer runs.") + "When non-nil, a Lisp timestamp updated when the speedbar timer runs.") (defun erc-speedbar--prod-dframe-timer (&rest _) "Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'." diff --git a/lisp/erc/erc-stamp.el b/lisp/erc/erc-stamp.el index 7788f0b2d68..bebc1d0be38 100644 --- a/lisp/erc/erc-stamp.el +++ b/lisp/erc/erc-stamp.el @@ -210,11 +210,11 @@ from entering them and instead jump over them." (defvar erc-stamp--current-time nil "The current time when calling `erc-insert-timestamp-function'. -Specifically, this is the same lisp time object used to create +Specifically, this is the same Lisp time object used to create the stamp passed to `erc-insert-timestamp-function'.") (cl-defgeneric erc-stamp--current-time () - "Return a lisp time object to associate with an IRC message. + "Return a Lisp time object to associate with an IRC message. This becomes the message's `erc--ts' text property." (erc-compat--current-lisp-time)) diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 40e83fff974..39a4775ddca 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -760,7 +760,7 @@ the number of unread messages, according to variables `erc-track-showcount' and `erc-track-showcount-string'. If `erc-track-use-faces' is true and FACES are provided, format -STRING with them. When the mouse hovers above the button, STRING +STRING with them. When the mouse hovers above the button, STRING is displayed according to `erc-track-mouse-face'." ;; We define a new sparse keymap every time, because 1. this data ;; structure is very small, the alternative would require us to diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 58b314e5f8e..a94a4366cfa 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -1868,7 +1868,7 @@ the value of this option is DISPLAY-FUNCTION." "How to display buffers as a result of user interaction. This affects commands like /QUERY and /JOIN when issued interactively at the prompt. It does not apply when calling a -handler for such a command, like `erc-cmd-JOIN', from lisp code. +handler for such a command, like `erc-cmd-JOIN', from Lisp code. See `erc-buffer-display' for a full description of available values. @@ -2269,7 +2269,7 @@ buffer rather than a server buffer.") list match menu move-to-prompt netsplit networks readonly ring stamp track) "Modules to enable while connecting. -When modifying this option in lisp code, use a Custom-friendly +When modifying this option in Lisp code, use a Custom-friendly facilitator, like `setopt', or call `erc-update-modules' afterward. This ensures a consistent ordering and disables removed modules. It also gives packages access to the hook @@ -4476,7 +4476,7 @@ Called with position indicating boundary of interval to be excised.") (defun erc-cmd-CLEAR () "Clear messages in current buffer after informing active modules. Expect modules to perform housekeeping tasks to withstand the -disruption. When called from lisp code, only clear messages up +disruption. When called from Lisp code, only clear messages up to but not including the one occupying the current line." (with-silent-modifications (let ((max (if (>= (point) erc-insert-marker) @@ -7287,7 +7287,7 @@ status switches among VOICE, HALFOP, OP, ADMIN, and OWNER to be the symbol `on' or `off' when needing to influence a new or existing `erc-channel-user' object's `status' slot. Likewise, when UPDATE-MESSAGE-TIME is non-nil, update or initialize the -`last-message-time' slot to the current-time. If changes occur, +`last-message-time' slot to the `current-time'. If changes occur, including creation, run `erc-channel-members-changed-hook'. Return non-nil when meaningful changes, including creation, have occurred. @@ -9172,7 +9172,7 @@ Currently only used by the option `erc-prompt-format'.") ;; As of ERC 5.6, this is identical to the away variant aside from ;; the var names and `eq', which isn't important. (defun erc--format-user-modes () - "Return server's user modes as a string" + "Return server's user modes as a string." (and-let* ((indicator (erc-with-server-buffer (or erc--user-modes-indicator (setq erc--user-modes-indicator (list ""))))) @@ -9729,7 +9729,7 @@ or `erc-kill-buffer-hook' if any other buffer." (defun erc-check-text-conversion () "Check if point is within the ERC prompt and toggle text conversion. If `text-conversion-style' is not `action' if point is within the -prompt or `nil' otherwise, set it to such a value, so as to +prompt or nil otherwise, set it to such a value, so as to guarantee that the input method functions properly for the purpose of typing within the ERC prompt." (when (and (eq major-mode 'erc-mode) -- 2.39.2