branch: externals/denote-journal
commit 38f965da5a4a22229eb744beae0260f3e1b7c90a
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Document the denote-journal-interval in its main command and the manual
---
README.org | 7 +++++++
denote-journal.el | 5 ++++-
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index bdb92bb618..11b25db852 100644
--- a/README.org
+++ b/README.org
@@ -212,6 +212,13 @@ prompt, though users can opt in to the more advanced
minibuffer+calendar date picker that Org uses for its own date
selection operations.
+#+vindex: denote-journal-interval
+This command consults the user option ~denote-journal-interval~ to
+determine when to create a new file or visit an existing one. The
+~denote-journal-interval~ can be set to a value of =daily=, =weekly=,
+=monthly=, or =yearly=. Any other value is internall treated as
+=daily=. [ The ~denote-journal-interval~ is part of {{{development-version}}}.
]
+
** Link to a journal entry or create it if missing
:PROPERTIES:
:CUSTOM_ID: h:link-to-a-journal-entry-or-create-it-if-missing
diff --git a/denote-journal.el b/denote-journal.el
index 2d471f4b40..6830721e03 100644
--- a/denote-journal.el
+++ b/denote-journal.el
@@ -326,7 +326,10 @@ date selection module.
When called from Lisp, DATE is a string and has the same format
as that covered in the documentation of the `denote' function.
-It is internally processed by `denote-valid-date-p'."
+It is internally processed by `denote-valid-date-p'.
+
+Consult the user option `denote-journal-interval' to determine when to
+create a new file or visit an existing one."
(interactive
(list
(when current-prefix-arg
