summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien <bzg@gnu.org>2020-02-22 10:33:07 +0100
committerBastien <bzg@gnu.org>2020-02-22 10:33:07 +0100
commit5dee070fb2deedcbb3d0527c7484deb8973e7817 (patch)
tree2d0e09f2c8d773751766d76d4714f08a04c736cb
parente360cd8f3a1797c944528a73c1f1523c7909cdce (diff)
downloadorg-mode-5dee070fb2deedcbb3d0527c7484deb8973e7817.tar.gz
lisp/ol-bbdb.el (org-bbdb-anniversaries): Enhance docstring
* lisp/ol-bbdb.el (org-bbdb-anniversaries): Enhance docstring. Thanks to Andrés Ramírez for suggesting this.
-rw-r--r--lisp/ol-bbdb.el4
1 files changed, 3 insertions, 1 deletions
diff --git a/lisp/ol-bbdb.el b/lisp/ol-bbdb.el
index c6e5ab3..0953aff 100644
--- a/lisp/ol-bbdb.el
+++ b/lisp/ol-bbdb.el
@@ -362,7 +362,9 @@ This is used by Org to re-create the anniversary hash table."
;;;###autoload
(defun org-bbdb-anniversaries ()
- "Extract anniversaries from BBDB for display in the agenda."
+ "Extract anniversaries from BBDB for display in the agenda.
+When called programmatically, this function expects the `date'
+variable to be globally bound."
(require 'bbdb)
(require 'diary-lib)
(unless (hash-table-p org-bbdb-anniv-hash)