On Wed, Jan 8, 2020 at 12:35 AM Eric Sunshine <sunshine@xxxxxxxxxxxxxx> wrote: > > > 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
