master 7d47651d01: project-buffers: Describe the default implementation

[Dmitry Gutov]

branch: master
commit 7d47651d0168c863ad9e9b07921a42dc18029276
Author: Dmitry Gutov <dgutov@yandex.ru>
Commit: Dmitry Gutov <dgutov@yandex.ru>

    project-buffers: Describe the default implementation
    
    * lisp/progmodes/project.el (project-buffers):
    Describe what the default implementation is doing (bug#58784).
---
 lisp/progmodes/project.el | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index ec453baf72..6d062aa8fa 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -353,7 +353,10 @@ Also quote LOCAL-FILES if `default-directory' is quoted."
               local-files))))
 
 (cl-defgeneric project-buffers (project)
-  "Return the list of all live buffers that belong to PROJECT."
+  "Return the list of all live buffers that belong to PROJECT.
+
+The default implementation matches the current open buffers to
+PROJECT root using the value of `default-directory' in each one."
   (let ((root (expand-file-name (file-name-as-directory (project-root 
project))))
         bufs)
     (dolist (buf (buffer-list))