diff options
author | Olivier Certner <olce.emacs@certner.fr> | 2021-01-13 17:39:54 +0100 |
---|---|---|
committer | Amin Bandali <bandali@gnu.org> | 2021-09-11 22:54:44 -0400 |
commit | fb1f0dfec968d74e887c457e34300ae02a328d52 (patch) | |
tree | c4a983ef8be99bde53e2f4956478d31105abc084 | |
parent | 252a769b11689d13796db6f76c2935374796b079 (diff) | |
download | emacs-fb1f0dfec968d74e887c457e34300ae02a328d52.tar.gz |
ERC: Track: Fix documentation of structure of 'erc-modified-channels-alist'
* lisp/erc/erc-track.el (erc-modified-channels-alist): Fix the
docstring: each element is a dotted list where the last cdr is
sometimes a proper list, making the element only sometimes a proper
list.
-rw-r--r-- | lisp/erc/erc-track.el | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 11270770659..b6055b6fdab 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -281,14 +281,17 @@ nil - don't add to mode line." (defvar erc-modified-channels-alist nil "An ALIST used for tracking channel modification activity. -Each element looks like (BUFFER COUNT FACE) where BUFFER is a buffer -object of the channel the entry corresponds to, COUNT is a number -indicating how often activity was noticed, and FACE is the face to use -when displaying the buffer's name. See `erc-track-faces-priority-list', -and `erc-track-showcount'. +Each element is a list of the form (BUFFER COUNT . FACE) where +BUFFER is a buffer object of the channel the entry corresponds +to, COUNT is a number indicating how often activity was noticed, +and FACE is a face (or a list of faces) to use when displaying the +buffer's name. Entries in this list should only happen for buffers where activity occurred -while the buffer was not visible.") +while the buffer was not visible. + +See also `erc-track-faces-priority-list', +`erc-track-faces-normal-list' and `erc-track-showcount'.") (defcustom erc-track-showcount nil "If non-nil, count of unseen messages will be shown for each channel." |