{"thread":{"id":"46054","subject":"[PATCH] change 'commands' to comments and improve wording","startedAt":"2017-05-27T04:53:26Z","lastAt":"2017-05-29T01:03:56Z","messageCount":2,"participants":["Adrian","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"320860","messageId":"0102015c4809f8c7-a5cb604c-782d-4a10-87e1-2fe23e9989ba-000000@eu-west-1.amazonses.com","threadId":"46054","inReplyTo":null,"subject":"[PATCH] change 'commands' to comments and improve wording","fromName":"Adrian","fromEmail":"forbesa06@gmail.com","sentAt":"2017-05-27T03:53:52Z","receivedAt":"2017-05-27T04:53:26Z","isPatch":true,"sender":{"key":"forbesa06@gmail.com","avatar":null},"body":"---\n Documentation/git-stash.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt\nindex 70191d06b69e..3899d36b2bab 100644\n--- a/Documentation/git-stash.txt\n+++ b/Documentation/git-stash.txt\n@@ -233,7 +233,7 @@ return to your original branch to make the emergency fix, like this:\n $ git checkout -b my_wip\n $ git commit -a -m \"WIP\"\n $ git checkout master\n-$ edit emergency fix\n+# ... edit emergency fix ...\n $ git commit -a -m \"Fix in a hurry\"\n $ git checkout my_wip\n $ git reset --soft HEAD^\n@@ -245,7 +245,7 @@ You can use 'git stash' to simplify the above, like this:\n ----------------------------------------------------------------\n # ... hack hack hack ...\n $ git stash\n-$ edit emergency fix\n+# ... edit emergency fix ...\n $ git commit -a -m \"Fix in a hurry\"\n $ git stash pop\n # ... continue hacking ...\n@@ -261,11 +261,11 @@ each change before committing:\n # ... hack hack hack ...\n $ git add --patch foo            # add just first part to the index\n $ git stash save --keep-index    # save all other changes to the stash\n-$ edit/build/test first part\n+# ... edit, build and test first part ...\n $ git commit -m 'First part'     # commit fully tested change\n $ git stash pop                  # prepare to work on all other changes\n # ... repeat above five steps until one commit remains ...\n-$ edit/build/test remaining parts\n+# ... edit, build and test remaining parts ...\n $ git commit foo -m 'Remaining parts'\n ----------------------------------------------------------------\n \n\n--\nhttps://github.com/git/git/pull/361\n"},{"id":"320914","messageId":"xmqq8tlga2yz.fsf@gitster.mtv.corp.google.com","threadId":"46054","inReplyTo":"0102015c4809f8c7-a5cb604c-782d-4a10-87e1-2fe23e9989ba-000000@eu-west-1.amazonses.com","subject":"Re: [PATCH] change 'commands' to comments and improve wording","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-05-29T01:03:48Z","receivedAt":"2017-05-29T01:03:56Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Adrian <forbesa06@gmail.com> writes: (nothing)\n\nImagine a reader who finds the title of this commit in 3 weeks from\nnow among 200 other commits.  Do you think the reader can guess that\nthis is a documentation fix?  Can the reader tell this is about\n\"stash\"?\n\n    Subject: stash doc: write explanation as comments, not as commands\n\nor something, perhaps.  This commit is simple enough that it may not\nneed the body but explaining why would not hurt.  Perhaps like this:\n\n\n    In the illustration of workflows in \"git stash\" documentation,\n    where it shows sequence of 'git' commands, there are a few steps\n    that are not literal commands (i.e. \"here, you would use your\n    editor\").  Clarify that these are not something the user can\n    blindly cut-and-paste by turning them into comments.\n\nwould be clear enough.\n\n> ---\n\nAnd please sign-off (Documentation/SubmittingPatches) your patch.\n\nThanks.\n\n\n>  Documentation/git-stash.txt | 8 ++++----\n>  1 file changed, 4 insertions(+), 4 deletions(-)\n>\n> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt\n> index 70191d06b69e..3899d36b2bab 100644\n> --- a/Documentation/git-stash.txt\n> +++ b/Documentation/git-stash.txt\n> @@ -233,7 +233,7 @@ return to your original branch to make the emergency fix, like this:\n>  $ git checkout -b my_wip\n>  $ git commit -a -m \"WIP\"\n>  $ git checkout master\n> -$ edit emergency fix\n> +# ... edit emergency fix ...\n>  $ git commit -a -m \"Fix in a hurry\"\n>  $ git checkout my_wip\n>  $ git reset --soft HEAD^\n> @@ -245,7 +245,7 @@ You can use 'git stash' to simplify the above, like this:\n>  ----------------------------------------------------------------\n>  # ... hack hack hack ...\n>  $ git stash\n> -$ edit emergency fix\n> +# ... edit emergency fix ...\n>  $ git commit -a -m \"Fix in a hurry\"\n>  $ git stash pop\n>  # ... continue hacking ...\n> @@ -261,11 +261,11 @@ each change before committing:\n>  # ... hack hack hack ...\n>  $ git add --patch foo            # add just first part to the index\n>  $ git stash save --keep-index    # save all other changes to the stash\n> -$ edit/build/test first part\n> +# ... edit, build and test first part ...\n>  $ git commit -m 'First part'     # commit fully tested change\n>  $ git stash pop                  # prepare to work on all other changes\n>  # ... repeat above five steps until one commit remains ...\n> -$ edit/build/test remaining parts\n> +# ... edit, build and test remaining parts ...\n>  $ git commit foo -m 'Remaining parts'\n>  ----------------------------------------------------------------\n>  \n>\n> --\n> https://github.com/git/git/pull/361\n"}]}