bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Eli Zaretskii
Subject: bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc fix.
Date: Sat, 24 Jun 2023 18:01:22 +0300

> Date: Sat, 24 Jun 2023 17:35:12 +0300
> From:  Eshel Yaron via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
> index 56c524bcab5..5e8628bbd0e 100644
> --- a/lisp/progmodes/project.el
> +++ b/lisp/progmodes/project.el
> @@ -219,9 +219,9 @@ 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\"
> -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?





reply via email to

[Prev in Thread] Current Thread [Next in Thread]