branch: externals/denote
commit e65c00c18f90ca53db774ad1b62d452d28469c41
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Document denote-keywords optional FILES-MATCHING-REGEXP (per commit 05d6c12)
---
README.org | 10 +++++++---
denote.el | 9 ++++-----
2 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/README.org b/README.org
index d724dbb3cc..aa9cafbc4c 100644
--- a/README.org
+++ b/README.org
@@ -4824,10 +4824,14 @@ The following sections cover the specifics.
#+findex: denote-keywords
+ Function ~denote-keywords~ :: Return appropriate list of keyword
- candidates. If ~denote-infer-keywords~ is non-nil, infer keywords
+ candidates. If ~denote-infer-keywords~ is non-nil, infer keywords
from existing notes and combine them into a list with
- ~denote-known-keywords~. Else use only the latter set of keywords
- ([[#h:6a92a8b5-d766-42cc-8e5b-8dc255466a23][Standard note creation]]).
+ ~denote-known-keywords~. Else use only the latter set of keywords
+ ([[#h:6a92a8b5-d766-42cc-8e5b-8dc255466a23][Standard note creation]]). In
the case of keyword inferrence, use
+ optional =FILES-MATCHING-REGEXP=, to extract keywords only from the
+ matching files. Otherwise, do it for all files. Filter inferred
+ keywords with the user option ~denote-excluded-keywords-regexp~. [
+ The optional =FILES-MATCHING-REGEXP= parameter is part of
{{{development-version}}}. ]
#+findex: denote-keywords-sort
+ Function ~denote-keywords-sort~ :: Sort =KEYWORDS= if
diff --git a/denote.el b/denote.el
index b948043b29..b37110c9e7 100644
--- a/denote.el
+++ b/denote.el
@@ -1800,16 +1800,15 @@ one that doesn't."
(defun denote-keywords (&optional files-matching-regexp)
"Return appropriate list of keyword candidates.
-If `denote-infer-keywords' is non-nil, infer keywords from
-existing notes and combine them into a list with
-`denote-known-keywords'. Else use only the latter.
+If `denote-infer-keywords' is non-nil, infer keywords from existing
+notes and combine them into a list with `denote-known-keywords'. Else
+use only the latter.
In the case of keyword inferrence, use optional FILES-MATCHING-REGEXP,
to extract keywords only from the matching files. Otherwise, do it for
all files.
-Inferred keywords are filtered by the user option
-`denote-excluded-keywords-regexp'."
+Filter inferred keywords with the user option
`denote-excluded-keywords-regexp'."
(delete-dups
(if denote-infer-keywords
(append (denote--inferred-keywords files-matching-regexp)
denote-known-keywords)
