branch: externals-release/org
commit db46706bec298a9f383407b44a00b7f99a3d0422
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
org-agenda-category-icon-alist: Improve docstirng
* lisp/org-agenda.el (org-agenda-category-icon-alist): Refer to
`org-agenda-prefix-format' in the docstring, as it is what controls
whether the icons are rendered at all.
---
lisp/org-agenda.el | 3 +++
1 file changed, 3 insertions(+)
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 10f25be8a8..b19d583601 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -2048,6 +2048,9 @@ the normal rules apply."
(defcustom org-agenda-category-icon-alist nil
"Alist of category icon to be displayed in agenda views.
+The icons are displayed in place of the %i placeholders in
+`org-agenda-prefix-format', which see.
+
Each entry should have the following format:
(CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
