From: Eli Zaretskii <eliz@gnu.org>
To: Boruch Baum <boruch_baum@gmx.com>
Cc: 48269@debbugs.gnu.org, fgunbin@fastmail.fm
Subject: bug#48269: 27.1: log-edit-generate-changelog-from-diff FAILURE
Date: Sun, 09 May 2021 21:54:44 +0300 [thread overview]
Message-ID: <83bl9j7n63.fsf@gnu.org> (raw)
In-Reply-To: <20210509184443.h2jvva6enamdegwd@E15-2016.optimum.net> (message from Boruch Baum on Sun, 9 May 2021 14:44:43 -0400)
> Date: Sun, 9 May 2021 14:44:43 -0400
> From: Boruch Baum <boruch_baum@gmx.com>
> Cc: fgunbin@fastmail.fm, 48269@debbugs.gnu.org
>
> > > There could be a sanity-check at the beginning of the function in the form:
> > >
> > > (unless (eq major-mode foo)
> > > (user-error "Not in foo buffer"))
> >
> > Yes, but my question was about the doc string: if it said the function
> > should be invoked from a *vc-log* buffer, would that have helped you?
> > Since your original report was against the doc string, I think it's
> > important to understand how we could improve it.
>
> The short answer then, is yes. But the long answer, adding a sanity
> check to the code, would avoid needing to look at the docstring.
Assuming the text of the user-error message could be detailed enough
to make sense. A doc string doesn't have to be short, so it's easier
to explain complex stuff there.
next prev parent reply other threads:[~2021-05-09 18:54 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-06 23:23 bug#48269: 27.1: log-edit-generate-changelog-from-diff FAILURE Boruch Baum
2021-05-07 1:26 ` Filipp Gunbin
2021-05-07 2:47 ` Boruch Baum
2021-05-07 6:20 ` Eli Zaretskii
2021-05-09 16:55 ` Boruch Baum
2021-05-09 17:15 ` Eli Zaretskii
2021-05-09 18:44 ` Boruch Baum
2021-05-09 18:54 ` Eli Zaretskii [this message]
2021-05-09 22:58 ` Filipp Gunbin
2021-05-10 0:13 ` Boruch Baum
2021-05-11 13:34 ` Lars Ingebrigtsen
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=83bl9j7n63.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=48269@debbugs.gnu.org \
--cc=boruch_baum@gmx.com \
--cc=fgunbin@fastmail.fm \
/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.