From: Basil L. Contovounesios <contovob@tcd.ie>
Date: Thu, 16 May 2019 22:26:27 +0000 (+0100)
Subject: Add docstring to project--read-file-cpd-relative
X-Git-Tag: emacs-27.0.90~2868
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b2c0eb63dd1f0d68de9bf7f14cc337df51617dcc;p=emacs.git

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.
---

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index eab508af3ac..cc45a71f576 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)