project-buffers: Describe the default implementation

* lisp/progmodes/project.el (project-buffers): Describe what the default implementation is doing (bug#58784).
emacs-mirror · Nov 4, 2022 · 7d47651 · 7d47651
1 parent ef45bfa
commit 7d47651
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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))