[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 5fd96522cc 4/4: Document variable denote-user-en
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 5fd96522cc 4/4: Document variable denote-user-enforced-denote-directory |
Date: |
Sun, 11 Jun 2023 12:57:39 -0400 (EDT) |
branch: externals/denote
commit 5fd96522ccd2fffaa4b70b58d63f7407f1a8bb87
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Document variable denote-user-enforced-denote-directory
This was introduced by Vedang Manerikar in 977c757, with further
changes by me in 20ddc97.
Vedang's contribution was made on the mailing list:
<https://lists.sr.ht/~protesilaos/denote/patches/41776>.
Vedang has assigned copyright to the Free Software Foundation.
---
README.org | 7 ++++++-
denote.el | 9 ++++++++-
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 0c94efaff4..bf2462ba3f 100644
--- a/README.org
+++ b/README.org
@@ -3386,7 +3386,12 @@ might change them without further notice.
+ Function ~denote-directory~ :: Return path of the variable
~denote-directory~ as a proper directory, also because it accepts a
directory-local value for what we internally refer to as "silos"
- ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate directories
for notes]]).
+ ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate directories
for notes]]). Custom Lisp code can
+ ~let~ bind the value of the variable ~denote-user-enforced-denote-directory~
+ to override what this function returns.
+
+ [ NOTE that the variable ~denote-user-enforced-denote-directory~ is
+ part of {{{development-version}}}. ]
#+findex: denote-directory-files
+ Function ~denote-directory-files~ :: Return list of absolute file
diff --git a/denote.el b/denote.el
index 1cc9dcc6b3..b79443ae39 100644
--- a/denote.el
+++ b/denote.el
@@ -537,7 +537,14 @@ Use this to `let' bind a directory path, thus overriding
what the
function `denote-directory' ordinarily returns.")
(defun denote-directory ()
- "Return path of variable `denote-directory' as a proper directory."
+ "Return path of variable `denote-directory' as a proper directory.
+Custom Lisp code can `let' bind the value of the variable
+`denote-user-enforced-denote-directory' to override what this
+function returns.
+
+Otherwise, the order of precedence is to first check for a silo
+before falling back to the value of the variable
+`denote-directory'."
(let ((path (or denote-user-enforced-denote-directory
(denote--default-directory-is-silo-p)
(denote--make-denote-directory)