On Fri, 10 Nov 2017, Eric Sunshine wrote:
> Thanks for the patch. Some comments below...
>
> On Fri, Nov 10, 2017 at 11:32 AM, Robert P. J. Day
> <rpjday@xxxxxxxxxxxxxx> wrote:
> > Tweak a number of files to mention "view" as an alternative to
> > "visualize":
>
> You probably want to end this sentence with a period, not a colon.
not sure about that, what's the standard when you're introducing a
code snippet?
> > Documentation/git-bisect.txt | 9 ++++-----
> > Documentation/user-manual.txt | 3 ++-
> > builtin/bisect--helper.c | 2 +-
> > contrib/completion/git-completion.bash | 2 +-
> > git-bisect.sh | 4 ++--
> > 5 files changed, 10 insertions(+), 10 deletions(-)
>
> The diffstat belongs below the "---" separator, otherwise this text
> will (undesirably) become part of the commit message proper.
no, i actually want that as part of the commit message. my standard
is, if there are 5 or more files that get changed, i like to include a
diff --stat in the commit message so people viewing the log can get a
quick idea of how much has changed. if that's not desired here, i can
remove it.
> > + git bisect visualize|view
>
> I think you need parentheses around these terms (see "git bisect
> skip", for example):
>
> git bisect (visualize | view)
ah, quite so.
> However, in this case, it might be easier for readers if each is
> presented on its own line (and subsequent discussion can make it clear
> that they are synonyms).
>
> git bisect visualize
> git bisect view
>
> But, that's a matter of taste...
given the precedent already established:
git bisect (bad|new|<term-new>) [<rev>]
git bisect (good|old|<term-old>) [<rev>...]
i'll go with the parentheses and no intervening spaces. i'll let that
posting simmer for a bit longer before posting "v2".
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
