From: Carsten Dominik <dominik@science.uva.nl>
Date: Thu, 25 Aug 2005 07:11:10 +0000 (+0000)
Subject: Documentation string of diary-modify-entry-list-string-function improved.
X-Git-Tag: emacs-pretest-22.0.90~7464
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=aa284296a0ec40635f84bd8e7c615aa5a30f362b;p=emacs.git

Documentation string of diary-modify-entry-list-string-function improved.
---

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'.