From: Damien Regad <dregad@mantisbt.org>
Date: Sun, 19 Feb 2017 22:13:56 GMT
Subject: Re: [PATCH] git-check-ref-format: fix typo in man page
Message-ID: <o8d5au$fqu$1@blaine.gmane.org>
In-Reply-To: <8147218721BE4F239D00CBFAFD9B495D@PhilipOakley>

Thanks all for the feedback.

On 2017-02-19 21:40, Philip Oakley wrote:
> For those not familiar with 'iff', then a change to the doc is worthwhile.

Exactly. Not being a native English speaker, I had never seen 'iff' used
before. Now that you guys have pointed me to its meaning I guess it
makes sense in this context.

That being said, IMHO software documentation is not a mathematics
textbook, and should be written in "plain" English, so

On 2017-02-19 03:27, Jeff King wrote:
> So maybe an overall improvement would be something like:
>
>   If the normalized refname is valid then print it to standard output
>   and exit with a status of 0. Otherwise, exit with a non-zero status.

I'll submit a revised patch shortly, following your suggestion.

Cheers
Damien