emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/denote 804ba6d600 1/4: Clarify denote-directory-files d


From: ELPA Syncer
Subject: [elpa] externals/denote 804ba6d600 1/4: Clarify denote-directory-files documentation
Date: Sat, 29 Oct 2022 23:57:30 -0400 (EDT)

branch: externals/denote
commit 804ba6d600fa95a182e87e28968374a0dc13c0f1
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Clarify denote-directory-files documentation
---
 README.org | 10 ++++++----
 denote.el  |  8 ++++++--
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/README.org b/README.org
index eb709e4722..83a221144a 100644
--- a/README.org
+++ b/README.org
@@ -2445,10 +2445,12 @@ might change them without further notice.
 
 #+findex: denote-directory-files
 + Function ~denote-directory-files~ :: Return list of absolute file
-  paths in variable ~denote-directory~. The returned files only need
-  to have an identifier.  This may include files that are not implied
-  by ~denote-file-type~.  Remember that the ~denote-directory~ accepts
-  a directory-local value ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain 
separate directories for notes]]).
+  paths in variable ~denote-directory~.  Files only need to have an
+  identifier.  The return value may thus include file types that are
+  not implied by ~denote-file-type~. To limit the return value to text
+  files, use the function ~denote-directory-text-only-files~.
+  Remember that the ~denote-directory~ accepts a directory-local value
+  ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate directories 
for notes]]).
 
 #+findex: denote-directory-text-only-files
 + Function ~denote-directory-text-only-files~ :: Return list of text
diff --git a/denote.el b/denote.el
index 37110a57a7..0fb1a89347 100644
--- a/denote.el
+++ b/denote.el
@@ -607,8 +607,12 @@ FILE must be an absolute path."
 
 (defun denote-directory-files ()
   "Return list of absolute file paths in variable `denote-directory'.
-The returned files only need to have an identifier.  This may
-include files that are not implied by `denote-file-type'.
+
+Files only need to have an identifier.  The return value may thus
+include file types that are not implied by `denote-file-type'.
+To limit the return value to text files, use the function
+`denote-directory-text-only-files'.
+
 Remember that the variable `denote-directory' accepts a dir-local
 value, as explained in its doc string."
   (mapcar



reply via email to

[Prev in Thread] Current Thread [Next in Thread]