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

Re: [PATCH 1/1] doc: fix a typo in gitcore-tutorial.txt

From
Heba Waly <heba.waly@gmail.com>
Date
Jan 8, 2020, 00:09 UTC
Message-ID
<CACg5j24A+g3_MFQvurd1Esy1s6A8W4VkLEWZjiP5WXxcTvqr-A@mail.gmail.com>
In-Reply-To
<CAPig+cTv5SOxEjjVQ7QvqJ1WbZGbcXegcCP4d5CK+nSdJvkNdQ@mail.gmail.com>
On Wed, Jan 8, 2020 at 12:35 AM Eric Sunshine <sunshine@sunshineco.com> wrote:
Show 20 quoted lines
>
>
> Calling this change a "typo fix" confuses reviewers since it's clearly
> not a mere typographical error. It looks instead as if you are
> recommending git-switch over git-checkout, so a reader would expect
> the commit message to justify that change rather than merely calling
> it a "typo fix". However, digging deeper, one finds that this is
> actually fixing an oversight from an earlier change which already
> updated this file to prefer git-switch over git-checkout.
>
> To save reviewers the time and effort of having to figure all this
> out, use the commit message to explain the situation. For example, you
> might say:
>
>     doc/gitcore-tutorial: fix prose to match example command
>
>     In 328c6cb853 (doc: promote "git switch", 2019-03-29), an example
>     was changed to use "git switch" rather than "git checkout" but an
>     instance of "git checkout" in the explanatory text preceding the
>     example was overlooked. Fix this oversight.

Looks like I overlooked this commit for its simplicity, I thought it was too simple and self explanatory. I agree with you though.

Thanks, Heba

Previous: Junio C HamanoNext: Heba Waly via GitGitGadget
Message 5 of 8 in “[Outreachy] doc: fix a typo in gitcore-tutorial.txt”
  1. 0/1 [Outreachy] doc: fix a typo in gitcore-tutorial.txtHeba Waly via GitGitGadget, Jan 7, 2020
  2. 1/1 doc: fix a typo in gitcore-tutorial.txtHeba Waly via GitGitGadget, Jan 7, 2020
  3. Eric SunshineJan 7, 2020
  4. Junio C HamanoJan 7, 2020
  5. Heba WalyJan 8, 2020
  6. 0/1 [Outreachy] doc/gitcore-tutorial: fix prose to match example commandHeba Waly via GitGitGadget, Jan 8, 2020
  7. 1/1 doc/gitcore-tutorial: fix prose to match example commandHeba Waly via GitGitGadget, Jan 8, 2020
  8. Junio C HamanoJan 8, 2020

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.