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

Re: [PATCH 1/4] Documentation: minor grammatical fixes in git-archive.txt.

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Mar 17, 2009, 09:18 UTC
Message-ID
<49BF6AD9.4020207@drmicha.warpmail.net>
In-Reply-To
<1237270577-17261-1-git-send-email-dmellor@whistlingcat.com>
David J. Mellor venit, vidit, dixit 17.03.2009 07:16:
> Signed-off-by: David J. Mellor <dmellor@whistlingcat.com>
[replying to the first patch since there's no cover letter]

For patches like this one, I wish we had a robust way of using "git format-patch --color-words"... "Robust" as in "working for most recipients + git-am".

So I applied your series locally and checked the --color-words diff. Nice work, all 4 of them!

One minor reoccurring issue is the following type of construct:

### The good/bad input is logged, and:

------------ $ git bisect log ------------

shows what you have done so far. ###

The first line is not a complete sentence. Neither is the last one, which you have to read together with the code inset (that's fine), which on the other belongs to the sentence started in line 1.

All of the above constitutes 1 sentence and should not be chopped in parts by the colon.

I know this construct is somewhat common, but I don't think it is correct. In any case it disrupts the reading flow. [In fact, that disruption is the very reason why it is sometimes used in the middle of a written sentence: as a substitute for the rhetoric element "pause".]

In the example above your patch introduces it, in other places it has been used before. So this might my an opportunity to get rid of it consistently ;)

Michael
Previous: Junio C HamanoNext: David J. Mellor
Message 8 of 9 in “Documentation: minor grammatical fixes in git-archive.txt.”
  1. 1/4 Documentation: minor grammatical fixes in git-archive.txt.David J. Mellor, Mar 17, 2009
  2. 2/4 Documentation: reworded the "Description" section of git-blame.txt.David J. Mellor, Mar 17, 2009
  3. 2/4 Documentation: reworded the "Description" section of git-bisect.txt.David J. Mellor, Mar 14, 2009
  4. 2/4 Documentation: reworded the "Description" section of git-bisect.txt.David J. Mellor, Mar 18, 2009
  5. 3/4 Documentation: minor grammatical fixes in git-blame.txt.David J. Mellor, Mar 17, 2009
  6. 4/4 Documentation: minor grammatical fixes in git-branch.txt.David J. Mellor, Mar 17, 2009
  7. Junio C HamanoMar 18, 2009
  8. Michael J GruberMar 17, 2009
  9. David J. MellorMar 18, 2009

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.