[elpa] externals/denote b6235ff099 4/9: Tweak manual's entry about 'denote-directory-files'

[ELPA Syncer]

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

    Tweak manual's entry about 'denote-directory-files'
---
 README.org | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/README.org b/README.org
index 40b70a7ea4..5e8c93dd72 100644
--- a/README.org
+++ b/README.org
@@ -3735,13 +3735,19 @@ might change them without further notice.
 
 #+findex: denote-directory-files
 + Function ~denote-directory-files~ :: Return list of absolute file
-  paths in variable ~denote-directory~. With nil parameters, files only
-  need to have an identifier. The return value may thus include file
-  types that are not implied by ~denote-file-type~. With optional
-  parameters, the results can be restricted to those matching a regexp,
-  they can omit the current buffer and they can be restricted to text
-  only files. 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~. Remember that the variable
+  ~denote-directory~ accepts a dir-local value, as explained in its
+  doc string ([[#h:15719799-a5ff-4e9a-9f10-4ca03ef8f6c5][Maintain separate 
directories for notes]]). With optional
+  =FILES-MATCHING-REGEXP=, restrict files to those matching the given
+  regular expression. With optional =OMIT-CURRENT= as a non-nil value,
+  do not include the current Denote file in the returned list. With
+  optional =TEXT-ONLY= as a non-nil value, limit the results to text
+  files that satisfy ~denote-file-is-note-p~. [ As part of
+  {{{development-version}}}, the ~denote-directory-files~ subsumes the
+  now-deprecated ~denote-directory-files-matching-regexp~,
+  ~denote-all-files~, ~denote-directory-text-only-files~. ]
 
 #+findex: denote-directory-subdirectories
 + Function ~denote-directory-subdirectories~ :: Return list of