branch: externals/denote
commit 9aed12156ee8a9a969fb411e525f64d0f3e95567
Merge: ec045e814b b5eac20052
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: GitHub <nore...@github.com>
Merge pull request #569 from jeanphilippegg/docstring
Add info in docstring of denote-file-name-components-order
---
denote.el | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/denote.el b/denote.el
index 9f8e9ba260..50d0c65b28 100644
--- a/denote.el
+++ b/denote.el
@@ -385,7 +385,12 @@ components are actually used in the order specified herein.
Before deciding on this, please consider the longer-term implications
of file names with varying patterns. Consistency makes things
predictable and thus easier to find. So pick one order and never touch
-it again. When in doubt, leave the default file-naming scheme as-is."
+it again. When in doubt, leave the default file-naming scheme as-is.
+
+This user option should only be used to build a file name. Custom code
+should not have behaviors that depend on its value. The reason is that
+its value can change over time and Denote should be able to handle past
+and current notes."
:group 'denote
:package-version '(denote . "3.0.0")
;; FIXME 2024-05-19: This technically works to display the user
