GNU bug report logs - #48269
27.1: log-edit-generate-changelog-from-diff FAILURE

Previous Next

Full log

Message #26 received at 48269 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Boruch Baum <boruch_baum <at> gmx.com>
Cc: 48269 <at> debbugs.gnu.org, fgunbin <at> fastmail.fm
Subject: Re: bug#48269: 27.1: log-edit-generate-changelog-from-diff FAILURE
Date: Sun, 09 May 2021 21:54:44 +0300

> Date: Sun, 9 May 2021 14:44:43 -0400
> From: Boruch Baum <boruch_baum <at> gmx.com>
> Cc: fgunbin <at> fastmail.fm, 48269 <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.