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

Re: [PATCH 1/5] Fix some typos, grammar or wording issues in the documentation

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Oct 3, 2023, 21:10 UTC
Message-ID
<CAPig+cTw-dZ8v33Ze1k35TQ3czq=4i-e9KEnMMPGsX4XKA848Q@mail.gmail.com>
In-Reply-To
<20231003220951+0200.221551-stepnem@smrk.net>
On Tue, Oct 3, 2023 at 4:09 PM Štěpán Němec <stepnem@smrk.net> wrote:
Show 16 quoted lines
> On Tue, 3 Oct 2023 14:30:38 -0400 Eric Sunshine wrote:
> > On Tue, Oct 3, 2023 at 4:28 AM Štěpán Němec <stepnem@smrk.net> wrote:
> >> diff --git a/contrib/README b/contrib/README
> >> @@ -24,14 +24,14 @@ lesser degree various foreign SCM interfaces, so you know the
> >>  I expect that things that start their life in the contrib/ area
> >> -to graduate out of contrib/ once they mature, either by becoming
> >> +graduate out of contrib/ once they mature, either by becoming
> >
> > You probably want to add a comma after "area".
>
> That would read awkward to me.  How about going the other way,
>
>   I expect things that start their life in the contrib/ area
>   to graduate out of contrib/ once they mature
>
> instead?
Sounds fine.
Show 12 quoted lines
> >> @@ -579,11 +579,10 @@ This test harness library does the following things:
> >> -Here are some recommented styles when writing test case.
> >
> > Do you want to fix the spelling error while you're here or is that
> > done in a later patch?
> >
> >     s/recommented/recommended/
>
> You really had me double-checking both the branch and the patch I sent
> here. :-D Unless I'm very much missing something, that line is _removed_
> by the patch (seemed redundant given the title immediately preceding
> it).
Ugh, so it is. Sorry for the noise.
Show 13 quoted lines
> >> - - Keep test title the same line with test helper function itself.
> >> + - Keep test titles and helper function invocations on the same line.
> >
> > This would be clearer if it was switched around. Either:
> >
> >     Keep the test_expect_* function call and test title on the same line.
> >
> > or, more verbosely:
> >
> >    Place the test title on the same line as the test_expect_* call
> >    which precedes it.
>
> I'll take your first suggestion.
I like the first suggestion better too.
Previous: Junio C HamanoNext: Štěpán Němec
Message 13 of 20 in “Fix some typos, grammar or wording issues in the documentation”
  1. 1/5 Fix some typos, grammar or wording issues in the documentationŠtěpán Němec, Oct 3, 2023
  2. 2/5 doc/diff-options: improve wording of the log.diffMerges mentionŠtěpán Němec, Oct 3, 2023
  3. 3/5 git-jump: admit to passing merge mode args to ls-filesŠtěpán Němec, Oct 3, 2023
  4. Eric SunshineOct 3, 2023
  5. Štěpán NěmecOct 3, 2023
  6. Junio C HamanoOct 3, 2023
  7. Junio C HamanoOct 3, 2023
  8. 4/5 doc/gitk: s/sticked/stuck/Štěpán Němec, Oct 3, 2023
  9. 5/5 t/README: fix multi-prerequisite exampleŠtěpán Němec, Oct 3, 2023
  10. Eric SunshineOct 3, 2023
  11. Štěpán NěmecOct 3, 2023
  12. Junio C HamanoOct 3, 2023
  13. Eric SunshineOct 3, 2023
  14. 1/5 doc: fix some typos, grammar and wording issuesŠtěpán Němec, Oct 5, 2023
  15. 5/5 t/README: fix multi-prerequisite exampleŠtěpán Němec, Oct 5, 2023
  16. 3/5 git-jump: admit to passing merge mode args to ls-filesŠtěpán Němec, Oct 5, 2023
  17. 2/5 doc/diff-options: improve wording of the log.diffMerges mentionŠtěpán Němec, Oct 5, 2023
  18. 4/5 doc/gitk: s/sticked/stuck/Štěpán Němec, Oct 5, 2023
  19. Junio C HamanoOct 5, 2023
  20. Junio C HamanoOct 18, 2023

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.