[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc
From: |
Eshel Yaron |
Subject: |
bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc fix. |
Date: |
Sat, 24 Jun 2023 18:32:00 +0300 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
Eli Zaretskii <eliz@gnu.org> writes:
>> 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\"
>> -project instance.
>> +else call the function specified by `project-prompter' to prompt
>> +the user for a project's directory, and if no project is found
>> +there, return a \"transient\" project instance.
>
> This starts by describing the implementation instead of describing the
> behavior first. The doc string will be more useful if reworded like
> this:
>
> 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 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.
>
> OK?
Yes, that's clearer, thanks. Should I send an updated patch?