changeset 65108:3c2360bf81c4

Documentation string of diary-modify-entry-list-string-function improved.
author Carsten Dominik <dominik@science.uva.nl>
date Thu, 25 Aug 2005 07:11:10 +0000
parents 8e982d56281b
children 2aed3dcccd0d
files lisp/calendar/diary-lib.el
diffstat 1 files changed, 3 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/calendar/diary-lib.el	Thu Aug 25 07:06:07 2005 +0000
+++ b/lisp/calendar/diary-lib.el	Thu Aug 25 07:11:10 2005 +0000
@@ -1652,8 +1652,9 @@
 
 (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'.