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.
This commit is contained in:
Bastien 2020-02-22 10:33:07 +01:00
parent e360cd8f3a
commit 5dee070fb2
1 changed files with 3 additions and 1 deletions

View File

@ -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)