; Improve documentation of a recent change

* lisp/progmodes/project.el (project-files-relative-names):
* etc/NEWS: Improve documentation of 'project-files-relative-names'.

1 files changed, 5 insertions, 4 deletions

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b716d442aed..a3181340411 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -324,10 +324,11 @@ end it with `/'.  DIR must be either `project-root' or one of
   (cdr project))
 
 (defvar project-files-relative-names nil
-  "When non-nil, `project-files' is allowed to return relative names.
-The names will be relative to the project root.  And this can only
-happen when all returned files are in the same directory. Meaning, the
-DIRS argument has to be nil or have only one element.")
+  "If non-nil, `project-files' is allowed to return relative file names.
+The file names should be relative to the project root.  And this can
+only happen when all returned files are in the same directory.
+In other words, the DIRS argument of `project-files' has to be nil or a
+list of only one element.")
 
 (cl-defgeneric project-files (project &optional dirs)
   "Return a list of files in directories DIRS in PROJECT.