bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc fix.

[Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>]

[-- Attachment #1: Type: text/plain, Size: 388 bytes --]

Dmitry Gutov <dmitry@gutov.dev> writes:

> On 24/06/2023 20:06, Eli Zaretskii wrote:
>> I would recommend waiting for Dmitry and Spencer to chime in, and
>> submit a followup after their comments, if any.
>
> Your suggested versions sounds good to me too, thanks.

Thanks, I'm attaching an updated patch following Eli's wording.

Also CC'ing Spencer in case there are further comments.



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: v2-0001-lisp-progmodes-project.el-project-current-Doc-fix.patch --]
[-- Type: text/x-patch, Size: 1400 bytes --]

From 8b41814b8dc52b50098a8282d9fb63cdec695a4e Mon Sep 17 00:00:00 2001
From: Eshel Yaron <me@eshelyaron.com>
Date: Sat, 24 Jun 2023 17:16:19 +0300
Subject: [PATCH v2] ; * lisp/progmodes/project.el (project-current): Doc fix.

Avoid saying that 'project-current' asks specifically for a directory,
as it can also ask for a project's directory by other identifiers,
such as the project's name, when 'project-prompter' is set to a
different value than the default 'project-prompt-project-dir'.
---
 lisp/progmodes/project.el | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 56c524bcab5..0f47c217d80 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -219,8 +219,10 @@ project-current
 
 When no project is found in that directory, the result depends on
 the value of MAYBE-PROMPT: if it is nil or omitted, return nil,
-else ask the user for a directory in which to look for the
-project, and if no project is found there, return a \"transient\"
+else prompt the user for the project to use.  To prompt for a
+project, call the function specified by `project-prompter', which
+returns the directory in which to look for the project.  If no
+project is found in that directory, return a \"transient\"
 project instance.
 
 The \"transient\" project instance is a special kind of value
-- 
2.41.0