[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
emacs-27 fb1f0df 1/2: ERC: Track: Fix documentation of structure of 'erc
From: |
Amin Bandali |
Subject: |
emacs-27 fb1f0df 1/2: ERC: Track: Fix documentation of structure of 'erc-modified-channels-alist' |
Date: |
Sat, 11 Sep 2021 22:57:56 -0400 (EDT) |
branch: emacs-27
commit fb1f0dfec968d74e887c457e34300ae02a328d52
Author: Olivier Certner <olce.emacs@certner.fr>
Commit: Amin Bandali <bandali@gnu.org>
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.
---
lisp/erc/erc-track.el | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el
index 1127077..b6055b6 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."