[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote ed1ec988df 3/3: Improve denote-infer-keywords do
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote ed1ec988df 3/3: Improve denote-infer-keywords doc string |
Date: |
Mon, 4 Jul 2022 02:57:33 -0400 (EDT) |
branch: externals/denote
commit ed1ec988df525e0da4322b56d33e09b030432126
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Improve denote-infer-keywords doc string
---
denote.el | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/denote.el b/denote.el
index 96a2d55d87..260f91c5c7 100644
--- a/denote.el
+++ b/denote.el
@@ -138,16 +138,26 @@ Also see user options: `denote-allow-multi-word-keywords',
:type '(repeat string))
(defcustom denote-infer-keywords t
- "Whether to infer keywords.
+ "Whether to infer keywords from existing notes' file names.
When non-nil, search the file names of existing notes in the
variable `denote-directory' for their keyword field and extract
the entries as \"inferred keywords\". These are combined with
`denote-known-keywords' and are presented as completion
-candidated while using `denote' interactively.
+candidates while using `denote' and related commands
+interactively.
If nil, refrain from inferring keywords. The aforementioned
-completion prompt only shows the `denote-known-keywords'."
+completion prompt only shows the `denote-known-keywords'. Use
+this if you want to enforce a restricted vocabulary.
+
+Inferred keywords are specific to the value of the variable
+`denote-directory'. If a silo with a local value is used, as
+explained in that variable's doc string, the inferred keywords
+are specific to the given silo.
+
+For advanced Lisp usage, the function `denote-keywords' returns
+the appropriate list of strings."
:group 'denote
:type 'boolean)