summaryrefslogtreecommitdiff
path: root/lisp/calendar/diary-lib.el
diff options
context:
space:
mode:
authorCarsten Dominik <dominik@science.uva.nl>2005-08-25 07:11:10 +0000
committerCarsten Dominik <dominik@science.uva.nl>2005-08-25 07:11:10 +0000
commitaa284296a0ec40635f84bd8e7c615aa5a30f362b (patch)
treecb6e41d89eb169ddf4c6520f39a1b53a998c7cb4 /lisp/calendar/diary-lib.el
parent9a20c79bcec8a2b87af788711c0f60ea1247af1d (diff)
downloademacs-aa284296a0ec40635f84bd8e7c615aa5a30f362b.tar.gz
Documentation string of diary-modify-entry-list-string-function improved.
Diffstat (limited to 'lisp/calendar/diary-lib.el')
-rw-r--r--lisp/calendar/diary-lib.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el
index ebcb4278ee7..1501131c2ae 100644
--- a/lisp/calendar/diary-lib.el
+++ b/lisp/calendar/diary-lib.el
@@ -1652,8 +1652,9 @@ marked on the calendar."
(defvar diary-modify-entry-list-string-function nil
"Function applied to entry string before putting it into the entries list.
-This is so that program that use the emacs diary for other purposes (e.g.
-planner.el and org.el) can modify the string or add properties to it.")
+Can be used by programs integrating a diary list into other buffers (e.g.
+org.el and planner.el) to modify the string or add properties to it.
+The function takes a string argument and must return a string.")
(defun add-to-diary-list (date string specifier &optional marker globcolor)
"Add the entry (DATE STRING SPECIFIER MARKER GLOBCOLOR) to `diary-entries-list'.