[Emacs-diffs] master b2c0eb6: Add docstring to project--read-file-cpd-relative

[Basil L. Contovounesios]

branch: master
commit b2c0eb63dd1f0d68de9bf7f14cc337df51617dcc
Author: Basil L. Contovounesios <address@hidden>
Commit: Basil L. Contovounesios <address@hidden>

    Add docstring to project--read-file-cpd-relative
    
    For discussion, see thread starting at:
    https://lists.gnu.org/archive/html/emacs-devel/2019-05/msg00460.html
    * lisp/progmodes/project.el (project--read-file-cpd-relative):
    Describe arglist as promised by user option
    project-read-file-name-function.
---
 lisp/progmodes/project.el | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index eab508a..cc45a71 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -477,6 +477,10 @@ For the arguments list, see 
`project--read-file-cpd-relative'."
 (defun project--read-file-cpd-relative (prompt
                                         all-files &optional predicate
                                         hist default)
+  "Read a file name, prompting with PROMPT.
+ALL-FILES is a list of possible file name completions.
+PREDICATE, HIST, and DEFAULT have the same meaning as in
+`completing-read'."
   (let* ((common-parent-directory
           (let ((common-prefix (try-completion "" all-files)))
             (if (> (length common-prefix) 0)