mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-30 12:21:25 -08:00
Code Issues Projects Releases Wiki Activity

; Amend some doc strings in ERC

Browse source 
* lisp/erc/erc-backend.el (define-erc-response-handler): Mention
important distinction between aliases for handlers and hooks, and note
expected type for the latter.
* lisp/erc/erc.el (erc--define-channel-user-status-compat-getter):
Mention that these accessors are not inlined like those generated by
`cl-defstruct'.
This commit is contained in:
F. Jason Park 2024-06-10 21:56:02 -07:00
parent e00af96c06
commit bbac7b9fa3
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lisp/erc/erc-backend.el
View file

@ -1649,6 +1649,10 @@ Would expand to:
See also `erc-server-311'.\"))
Note that while all ALIASES share the same handler function, each gets
its own distinct hook variable. The default value of these variables
may be a list or a function. Robust code should handle both.
\(fn (NAME &rest ALIASES) &optional EXTRA-FN-DOC EXTRA-VAR-DOC &rest FN-BODY)"
(declare (debug (&define [&name "erc-response-handler@"
;; No `def-edebug-elem-spec' in 27.

9
lisp/erc/erc.el
View file

@ -676,10 +676,11 @@ Also remove members from the server table if this was their only buffer."
(erc-remove-channel-users)))
(defmacro erc--define-channel-user-status-compat-getter (name c d)
"Define a gv getter for historical `erc-channel-user' status slot NAME.
Expect NAME to be a string, C to be its traditionally associated
letter, and D to be its fallback power-of-2 integer for non-ERC
buffers."
"Define accessor with gv getter for historical `erc-channel-user' slot NAME.
Expect NAME to be a string, C to be its traditionally associated letter,
and D to be its fallback power-of-2 integer for non-ERC buffers. Unlike
pre-ERC-5.6 accessors, do not bother generating a compiler macro for
inlining calls to these adapters."
`(defun ,(intern (concat "erc-channel-user-" name)) (u)
,(format "Get equivalent of pre-5.6 `%s' slot for `erc-channel-user'."
name)