GNU bug report logs - #57400
29.0.50; Support sending patches from VC directly

Previous Next

Full log

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: rpluim <at> gmail.com, 57400 <at> debbugs.gnu.org, ane <at> iki.fi, juri <at> linkov.net
Subject: Re: bug#57400: 29.0.50; Support sending patches from VC directly
Date: Thu, 13 Oct 2022 23:33:34 +0300

> Cc: Robert Pluim <rpluim <at> gmail.com>, 57400 <at> debbugs.gnu.org,
>  Antoine Kalmbach <ane <at> iki.fi>
> From: Philip Kaludercic <philipk <at> posteo.net>
> Date: Thu, 13 Oct 2022 20:25:03 +0000
> 
> -(defun vc-git-symbolic-commit (commit)
> +(defun vc-git-symbolic-commit (commit &optional force)
>    "Translate COMMIT string into symbolic form.
> -Returns nil if not possible."
> +Returns nil if not possible.

And if possible?  I guess the first sentence lacks something it should
say about that?  (Also, we use "Return", not "Returns", to be
consistent with "Translate".)

>                               If the optional argument FORCE is
> +non-nil, revisions containing positional
> +arguments (e.g. \"master~8\") will also be accepted."

It is not a good idea to use "also" when you didn't explain before
that what this does without FORCE.  (Maybe this should be part of the
explanation of what you mean by "not possible" above?)

Also, there's a passive tense here...

And finally, you use "positional arguments", but "man gitrevisions"
doesn't use this term at all.  So maybe we should use a more accepted
terminology, or at least provide more than just one example to explain
that via the examples?

Thanks.

Previous Next

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