[Outreachy] doc/gitcore-tutorial: fix prose to match example command #515
Conversation
|
@dscho it can't be the typo fix that's causing all these checks to fail, no? |
|
/submit |
|
Submitted as pull.515.git.1578391553.gitgitgadget@gmail.com |
![gitgitgadget[bot]](https://avatars.githubusercontent.com/in/12836?s=60&v=4){kind=small}
| @@ -751,7 +751,7 @@ to it. | |||
| ================================================ | |||
There was a problem hiding this comment.
On the Git mailing list, Eric Sunshine wrote (reply to this):
On Tue, Jan 7, 2020 at 5:06 AM Heba Waly via GitGitGadget
<gitgitgadget@gmail.com> wrote:
> doc: fix a typo in gitcore-tutorial.txt
>
> Signed-off-by: Heba Waly <heba.waly@gmail.com>
> ---
> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
> @@ -751,7 +751,7 @@ to it.
> ================================================
> If you make the decision to start your new branch at some
> other point in the history than the current `HEAD`, you can do so by
> -just telling 'git checkout' what the base of the checkout would be.
> +just telling 'git switch' what the base of the checkout would be.
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.
There was a problem hiding this comment.
On the Git mailing list, Junio C Hamano wrote (reply to this):
Eric Sunshine <sunshine@sunshineco.com> writes:
> 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.
Thanks for a ncie educational session ;-)
There was a problem hiding this comment.
On the Git mailing list, Heba Waly wrote (reply to this):
On Wed, Jan 8, 2020 at 12:35 AM Eric Sunshine <sunshine@sunshineco.com> 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
Nope, all green now (I restarted it, I think it was a transient Ubuntu package serving problem). |
In 328c6cb (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. Signed-off-by: Heba Waly <heba.waly@gmail.com>
HebaWaly
force-pushed
the
gitcore_tutorial_typo
branch
from
ee8636e
to
0c75cd8
Compare
Thanks! Is there a way for me to restart it as well in such situations or does it require admin permissions? |
HebaWaly
changed the title
|
/submit |
|
Submitted as pull.515.v2.git.1578443496.gitgitgadget@gmail.com |
I wouldn't know ;-) Next time you see a failure, can you go to the "Checks" tab and see whether there is any "Re-run" link and/or "Re-run checks" button? For me, it looks like this:
|
|
This is the button I've been looking for :) no I'm quite sure I've looked for it and couldn't find it. So probably no access to it. Thanks :) |
😄
|
| @@ -751,7 +751,7 @@ to it. | |||
| ================================================ | |||
There was a problem hiding this comment.
On the Git mailing list, Junio C Hamano wrote (reply to this):
"Heba Waly via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Heba Waly <heba.waly@gmail.com>
>
> 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.
>
> Signed-off-by: Heba Waly <heba.waly@gmail.com>
> ---
> Documentation/gitcore-tutorial.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
> index f880d21dfb..c0b95256cc 100644
> --- a/Documentation/gitcore-tutorial.txt
> +++ b/Documentation/gitcore-tutorial.txt
> @@ -751,7 +751,7 @@ to it.
> ================================================
> If you make the decision to start your new branch at some
> other point in the history than the current `HEAD`, you can do so by
> -just telling 'git checkout' what the base of the checkout would be.
> +just telling 'git switch' what the base of the checkout would be.
> In other words, if you have an earlier tag or branch, you'd just do
>
> ------------
Thanks. The part before this paragraph does illustrate the use of
"switch", and we should talk about that command here, too.
|
This patch series was integrated into pu via git@fc55178. |
|
This branch is now known as |
|
This patch series was integrated into pu via git@ab9806f. |
|
This patch series was integrated into pu via git@b99fa3b. |
|
This patch series was integrated into next via git@9de015c. |
|
This patch series was integrated into pu via git@854cdfa. |
|
This patch series was integrated into pu via git@872e109. |
|
This patch series was integrated into pu via git@43358c6. |
|
This patch series was integrated into pu via git@9a77424. |
|
This patch series was integrated into next via git@25e4fca. |
|
This patch series was integrated into pu via git@401255c. |
|
This patch series was integrated into master via git@0f50154. |
|
Closed via 0f50154. |
In 328c6cb (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.