all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 64266@debbugs.gnu.org
Subject: bug#64266: [PATCH] ; * lisp/progmodes/project.el (project-current): Doc fix.
Date: Sat, 24 Jun 2023 18:32:00 +0300	[thread overview]
Message-ID: <m1v8fcub9r.fsf@eshelyaron.com> (raw)
In-Reply-To: <83cz1kzyyl.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 24 Jun 2023 18:01:22 +0300")

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?





  reply	other threads:[~2023-06-24 15:32 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-24 14:35 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
2023-06-24 15:01 ` Eli Zaretskii
2023-06-24 15:32   ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-06-24 17:06     ` Eli Zaretskii
2023-06-25  2:20       ` Dmitry Gutov
2023-07-09  7:57         ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-07-09 13:19           ` sbaugh
2023-07-13  6:15           ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m1v8fcub9r.fsf@eshelyaron.com \
    --to=bug-gnu-emacs@gnu.org \
    --cc=64266@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=me@eshelyaron.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.