git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] git-check-ref-format: fix typo in man page

From
Damien Regad <dregad@mantisbt.org>
Date
Feb 19, 2017, 22:13 UTC
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

Previous: Philip Oakley
Message 6 of 6 in “git-check-ref-format: fix typo in man page”
  1. git-check-ref-format: fix typo in man pageDamien Regad, Feb 18, 2017
  2. Jacob KellerFeb 19, 2017
  3. Philip OakleyFeb 19, 2017
  4. Jeff KingFeb 19, 2017
  5. Philip OakleyFeb 19, 2017
  6. Damien RegadFeb 19, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.