diff options
| author | Stefan Kangas | 2024-07-08 16:41:02 +0200 |
|---|---|---|
| committer | Stefan Kangas | 2024-07-08 16:41:02 +0200 |
| commit | c85f67a66dfc9b3333a466a5fcd313425889ee6e (patch) | |
| tree | 1c316a8ea87918800d2d7b48a6500759ab1babf3 | |
| parent | e392382e2e26ea6d6afa459621c289007c8ea77c (diff) | |
| download | emacs-c85f67a66dfc9b3333a466a5fcd313425889ee6e.tar.gz emacs-c85f67a66dfc9b3333a466a5fcd313425889ee6e.zip | |
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.
| -rw-r--r-- | lisp/erc/erc-backend.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-button.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-dcc.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-fill.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-speedbar.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-stamp.el | 4 | ||||
| -rw-r--r-- | lisp/erc/erc-track.el | 2 | ||||
| -rw-r--r-- | 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 | |||
| 260 | where PARAMETER is a string and VALUE is a string or nil. For | 260 | where PARAMETER is a string and VALUE is a string or nil. For |
| 261 | compatibility, a raw parameter of the form \"FOO=\" becomes | 261 | compatibility, a raw parameter of the form \"FOO=\" becomes |
| 262 | (\"FOO\" . \"\") even though it's equivalent to the preferred | 262 | (\"FOO\" . \"\") even though it's equivalent to the preferred |
| 263 | canonical form \"FOO\" and its lisp representation (\"FOO\"). | 263 | canonical form \"FOO\" and its Lisp representation (\"FOO\"). |
| 264 | 264 | ||
| 265 | Some examples of possible parameters sent by servers: | 265 | Some examples of possible parameters sent by servers: |
| 266 | CHANMODES=b,k,l,imnpst - list of supported channel modes | 266 | 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." | |||
| 815 | 815 | ||
| 816 | (defun erc-button--display-error-with-buttons | 816 | (defun erc-button--display-error-with-buttons |
| 817 | (from to fun nick-p &optional data regexp) | 817 | (from to fun nick-p &optional data regexp) |
| 818 | "Replace command in region with keys and return new bounds" | 818 | "Replace command in region with keys and return new bounds." |
| 819 | (let* ((o (buffer-substring from to)) | 819 | (let* ((o (buffer-substring from to)) |
| 820 | (s (substitute-command-keys o)) | 820 | (s (substitute-command-keys o)) |
| 821 | (erc-button-face (and (equal o s) erc-button-face))) | 821 | (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. | |||
| 173 | 173 | ||
| 174 | The property :nick is treated specially, if it contains a `!' character, | 174 | The property :nick is treated specially, if it contains a `!' character, |
| 175 | it is treated as a nick!user@host string, and compared with the :nick property | 175 | it is treated as a nick!user@host string, and compared with the :nick property |
| 176 | value of the individual elements using string-equal. Otherwise it is | 176 | value of the individual elements using `string-equal'. Otherwise it is |
| 177 | compared with `erc-nick-equal-p' which is IRC case-insensitive." | 177 | compared with `erc-nick-equal-p' which is IRC case-insensitive." |
| 178 | (let ((list erc-dcc-list) | 178 | (let ((list erc-dcc-list) |
| 179 | result test) | 179 | 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 | |||
| 799 | like `erc-match-toggle-hidden-fools'." | 799 | like `erc-match-toggle-hidden-fools'." |
| 800 | (interactive "P") | 800 | (interactive "P") |
| 801 | (unless erc-fill-wrap-mode | 801 | (unless erc-fill-wrap-mode |
| 802 | (user-error "Module `fill-wrap' not active in current buffer.")) | 802 | (user-error "Module `fill-wrap' not active in current buffer")) |
| 803 | (save-excursion | 803 | (save-excursion |
| 804 | (with-silent-modifications | 804 | (with-silent-modifications |
| 805 | (let* ((rep (make-progress-reporter | 805 | (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." | |||
| 548 | "Speedbar update period.") | 548 | "Speedbar update period.") |
| 549 | 549 | ||
| 550 | (defvar-local erc-speedbar--last-ran nil | 550 | (defvar-local erc-speedbar--last-ran nil |
| 551 | "When non-nil, a lisp timestamp updated when the speedbar timer runs.") | 551 | "When non-nil, a Lisp timestamp updated when the speedbar timer runs.") |
| 552 | 552 | ||
| 553 | (defun erc-speedbar--prod-dframe-timer (&rest _) | 553 | (defun erc-speedbar--prod-dframe-timer (&rest _) |
| 554 | "Refresh speedbar if dormant for `erc-speedbar--force-update-interval-secs'." | 554 | "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." | |||
| 210 | 210 | ||
| 211 | (defvar erc-stamp--current-time nil | 211 | (defvar erc-stamp--current-time nil |
| 212 | "The current time when calling `erc-insert-timestamp-function'. | 212 | "The current time when calling `erc-insert-timestamp-function'. |
| 213 | Specifically, this is the same lisp time object used to create | 213 | Specifically, this is the same Lisp time object used to create |
| 214 | the stamp passed to `erc-insert-timestamp-function'.") | 214 | the stamp passed to `erc-insert-timestamp-function'.") |
| 215 | 215 | ||
| 216 | (cl-defgeneric erc-stamp--current-time () | 216 | (cl-defgeneric erc-stamp--current-time () |
| 217 | "Return a lisp time object to associate with an IRC message. | 217 | "Return a Lisp time object to associate with an IRC message. |
| 218 | This becomes the message's `erc--ts' text property." | 218 | This becomes the message's `erc--ts' text property." |
| 219 | (erc-compat--current-lisp-time)) | 219 | (erc-compat--current-lisp-time)) |
| 220 | 220 | ||
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 | |||
| 760 | `erc-track-showcount' and `erc-track-showcount-string'. | 760 | `erc-track-showcount' and `erc-track-showcount-string'. |
| 761 | 761 | ||
| 762 | If `erc-track-use-faces' is true and FACES are provided, format | 762 | If `erc-track-use-faces' is true and FACES are provided, format |
| 763 | STRING with them. When the mouse hovers above the button, STRING | 763 | STRING with them. When the mouse hovers above the button, STRING |
| 764 | is displayed according to `erc-track-mouse-face'." | 764 | is displayed according to `erc-track-mouse-face'." |
| 765 | ;; We define a new sparse keymap every time, because 1. this data | 765 | ;; We define a new sparse keymap every time, because 1. this data |
| 766 | ;; structure is very small, the alternative would require us to | 766 | ;; structure is very small, the alternative would require us to |
diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index b0be96d7b35..7cc7bf56252 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el | |||
| @@ -1868,7 +1868,7 @@ the value of this option is DISPLAY-FUNCTION." | |||
| 1868 | "How to display buffers as a result of user interaction. | 1868 | "How to display buffers as a result of user interaction. |
| 1869 | This affects commands like /QUERY and /JOIN when issued | 1869 | This affects commands like /QUERY and /JOIN when issued |
| 1870 | interactively at the prompt. It does not apply when calling a | 1870 | interactively at the prompt. It does not apply when calling a |
| 1871 | handler for such a command, like `erc-cmd-JOIN', from lisp code. | 1871 | handler for such a command, like `erc-cmd-JOIN', from Lisp code. |
| 1872 | See `erc-buffer-display' for a full description of available | 1872 | See `erc-buffer-display' for a full description of available |
| 1873 | values. | 1873 | values. |
| 1874 | 1874 | ||
| @@ -2269,7 +2269,7 @@ buffer rather than a server buffer.") | |||
| 2269 | list match menu move-to-prompt netsplit | 2269 | list match menu move-to-prompt netsplit |
| 2270 | networks readonly ring stamp track) | 2270 | networks readonly ring stamp track) |
| 2271 | "Modules to enable while connecting. | 2271 | "Modules to enable while connecting. |
| 2272 | When modifying this option in lisp code, use a Custom-friendly | 2272 | When modifying this option in Lisp code, use a Custom-friendly |
| 2273 | facilitator, like `setopt', or call `erc-update-modules' | 2273 | facilitator, like `setopt', or call `erc-update-modules' |
| 2274 | afterward. This ensures a consistent ordering and disables | 2274 | afterward. This ensures a consistent ordering and disables |
| 2275 | removed modules. It also gives packages access to the hook | 2275 | removed modules. It also gives packages access to the hook |
| @@ -4476,7 +4476,7 @@ Called with position indicating boundary of interval to be excised.") | |||
| 4476 | (defun erc-cmd-CLEAR () | 4476 | (defun erc-cmd-CLEAR () |
| 4477 | "Clear messages in current buffer after informing active modules. | 4477 | "Clear messages in current buffer after informing active modules. |
| 4478 | Expect modules to perform housekeeping tasks to withstand the | 4478 | Expect modules to perform housekeeping tasks to withstand the |
| 4479 | disruption. When called from lisp code, only clear messages up | 4479 | disruption. When called from Lisp code, only clear messages up |
| 4480 | to but not including the one occupying the current line." | 4480 | to but not including the one occupying the current line." |
| 4481 | (with-silent-modifications | 4481 | (with-silent-modifications |
| 4482 | (let ((max (if (>= (point) erc-insert-marker) | 4482 | (let ((max (if (>= (point) erc-insert-marker) |
| @@ -7288,7 +7288,7 @@ status switches among VOICE, HALFOP, OP, ADMIN, and OWNER to be | |||
| 7288 | the symbol `on' or `off' when needing to influence a new or | 7288 | the symbol `on' or `off' when needing to influence a new or |
| 7289 | existing `erc-channel-user' object's `status' slot. Likewise, | 7289 | existing `erc-channel-user' object's `status' slot. Likewise, |
| 7290 | when UPDATE-MESSAGE-TIME is non-nil, update or initialize the | 7290 | when UPDATE-MESSAGE-TIME is non-nil, update or initialize the |
| 7291 | `last-message-time' slot to the current-time. If changes occur, | 7291 | `last-message-time' slot to the `current-time'. If changes occur, |
| 7292 | including creation, run `erc-channel-members-changed-hook'. | 7292 | including creation, run `erc-channel-members-changed-hook'. |
| 7293 | Return non-nil when meaningful changes, including creation, have | 7293 | Return non-nil when meaningful changes, including creation, have |
| 7294 | occurred. | 7294 | occurred. |
| @@ -9173,7 +9173,7 @@ Currently only used by the option `erc-prompt-format'.") | |||
| 9173 | ;; As of ERC 5.6, this is identical to the away variant aside from | 9173 | ;; As of ERC 5.6, this is identical to the away variant aside from |
| 9174 | ;; the var names and `eq', which isn't important. | 9174 | ;; the var names and `eq', which isn't important. |
| 9175 | (defun erc--format-user-modes () | 9175 | (defun erc--format-user-modes () |
| 9176 | "Return server's user modes as a string" | 9176 | "Return server's user modes as a string." |
| 9177 | (and-let* ((indicator (erc-with-server-buffer | 9177 | (and-let* ((indicator (erc-with-server-buffer |
| 9178 | (or erc--user-modes-indicator | 9178 | (or erc--user-modes-indicator |
| 9179 | (setq erc--user-modes-indicator (list ""))))) | 9179 | (setq erc--user-modes-indicator (list ""))))) |
| @@ -9730,7 +9730,7 @@ or `erc-kill-buffer-hook' if any other buffer." | |||
| 9730 | (defun erc-check-text-conversion () | 9730 | (defun erc-check-text-conversion () |
| 9731 | "Check if point is within the ERC prompt and toggle text conversion. | 9731 | "Check if point is within the ERC prompt and toggle text conversion. |
| 9732 | If `text-conversion-style' is not `action' if point is within the | 9732 | If `text-conversion-style' is not `action' if point is within the |
| 9733 | prompt or `nil' otherwise, set it to such a value, so as to | 9733 | prompt or nil otherwise, set it to such a value, so as to |
| 9734 | guarantee that the input method functions properly for the | 9734 | guarantee that the input method functions properly for the |
| 9735 | purpose of typing within the ERC prompt." | 9735 | purpose of typing within the ERC prompt." |
| 9736 | (when (and (eq major-mode 'erc-mode) | 9736 | (when (and (eq major-mode 'erc-mode) |