From: Eshel Yaron <me@eshelyaron.com>
To: Dmitry Gutov <dmitry@gutov.dev>
Cc: emacs-devel@gnu.org
Subject: Re: master 9904376c797: Support calling 'project-current' with custom prompt
Date: Thu, 24 Oct 2024 09:30:07 +0200 [thread overview]
Message-ID: <m1a5euargg.fsf@macbookpro.home> (raw)
In-Reply-To: <98b80b2d-816f-4762-be8a-617b1b6380f4@gutov.dev> (Dmitry Gutov's message of "Wed, 23 Oct 2024 22:51:13 +0300")
Dmitry Gutov <dmitry@gutov.dev> writes:
>> JFYI, I'm using a custom project-prompter, which was not prepared to
>> be
>> called with an argument, so I got some unexpected errors until I
>> realized what changed. A quick lookup online shows that although this
>> option is quite new, a few others already set it to a custom function,
>> so it might be worth catching the "Wrong number of arguments" error.
>
> It's good of you to bring this up, but under what conditions do you
> encounter the breakage? Are there 3rd-party callers of
> 'project-current' already as well, that pass a string as MAYBE-PROMPT?
> If so, that's a little quicker than I expected. :)
Ah, no, you're right, I got the error through custom code of mine.
I adapted some code to call project-current with a string, without
adapting my project-prompter function accordingly.
> Catching an error might be a fine approach, but then a lot of people
> would miss out on the reason why the provided prompt is not used.
Yeah, that's a reasonable consideration too.
>> Also, I'd like to update the docstring of project-prompter along the
>> following lines, if it looks right to you:
>> diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
>> index 3cdaa7c2a76..6383bdc95d2 100644
>> --- a/lisp/progmodes/project.el
>> +++ b/lisp/progmodes/project.el
>> @@ -199,7 +199,9 @@ project-current-directory-override
>> (defcustom project-prompter #'project-prompt-project-dir
>> "Function to call to prompt for a project.
>> -Called with no arguments and should return a project root dir."
>> +The function is either called with no arguments or with one argument,
>> +which is the prompt string to use when prompting. It should return a
>> +project root directory."
>> :type '(choice (const :tag "Prompt for a project directory"
>> project-prompt-project-dir)
>> (const :tag "Prompt for a project name"
>
> Thanks, I've pushed a slight edit of that (sorry it went out without
> attribution). Also updated the corresponding NEWS entry.
Great, thank you.
Eshel
prev parent reply other threads:[~2024-10-24 7:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <172834239339.3048552.12080367051270999761@vcs3.savannah.gnu.org>
[not found] ` <20241007230633.CC7E91EAF92@vcs3.savannah.gnu.org>
2024-10-23 6:54 ` master 9904376c797: Support calling 'project-current' with custom prompt Eshel Yaron
2024-10-23 19:51 ` Dmitry Gutov
2024-10-24 7:30 ` Eshel Yaron [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m1a5euargg.fsf@macbookpro.home \
--to=me@eshelyaron.com \
--cc=dmitry@gutov.dev \
--cc=emacs-devel@gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).