Make the description of git stash save clearer
cover Make the description of git stash save clearer
This is an attempt to revive the discussion started in
https://public-inbox.org/git/0102016b8d597569-c1f6cfdc-cb45-4428-8737-cb1bc30655d8-000000@eu-west-1.amazonses.com/#t
Johannes Schindelin (1):
doc(stash): clarify the description of save
Documentation/git-stash.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
base-commit: 70bf0b755af4d1e66da25b7805cac0e481a082e4
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-384%2Fdscho%2Fclarify-stash-doc-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-384/dscho/clarify-stash-doc-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/384
Signature · 1 line
gitgitgadget
PATCH 1/1 doc(stash): clarify the description of `save`
From: Johannes Schindelin <[email protected]>
The original phrasing of this paragraph made at least one person stumble over the word "from" (thinking that it was a typo and "from" was intended), and other readers chimed in, agreeing that it was confusing:
https://public-inbox.org/git/0102016b8d597569-c1f6cfdc-cb45-4428-8737-cb1bc30655d8-000000@eu-west-1.amazonses.com/#t
Let's rewrite that paragraph for clarity.
--- Documentation/git-stash.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/git-stash.txt +3 -2
@@ -87,8 +87,9 @@ The `--patch` option implies `--keep-index`. You can use save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: This option is deprecated in favour of 'git stash push'. It - differs from "stash push" in that it cannot take pathspecs, - and any non-option arguments form the message. + differs from "stash push" in that it cannot take pathspecs. + Instead, all non-option arguments are concatenated to form the stash + message. list [<options>]::
Signature · 1 line
gitgitgadget
Re: [PATCH 1/1] doc(stash): clarify the description of `save`
Quoted 11 lines · Johannes Schindelin via GitGitGadget
From: Johannes Schindelin <[email protected]>
The original phrasing of this paragraph made at least one person stumble over the word "from" (thinking that it was a typo and "from" was intended), and other readers chimed in, agreeing that it was confusing:
https://public-inbox.org/git/0102016b8d597569-c1f6cfdc-cb45-4428-8737-cb1bc30655d8-000000@eu-west-1.amazonses.com/#tLet's rewrite that paragraph for clarity.
Inspired-by-a-patch-by Catalin Criste <[email protected]>Signed-off-by Johannes Schindelin <[email protected]>
Thanks for picking this thread up again, I had already forgotten about it. The updated wording sounds like an improvement to me.
Quoted 22 lines
--- Documentation/git-stash.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)Documentation/git-stash.txt +3
-2@@ -87,8 +87,9 @@ The `--patch` option implies `--keep-index`. You can use save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: This option is deprecated in favour of 'git stash push'. It - differs from "stash push" in that it cannot take pathspecs, - and any non-option arguments form the message. + differs from "stash push" in that it cannot take pathspecs. + Instead, all non-option arguments are concatenated to form the stash + message. list [<options>]::Signature · 1 line
gitgitgadget
Re: [PATCH 1/1] doc(stash): clarify the description of `save`
Quoted 8 lines · Thomas Gummerer
Quoted 7 lines · Johannes Schindelin via GitGitGadget
From: Johannes Schindelin <[email protected]>
The original phrasing of this paragraph made at least one person stumble over the word "from" (thinking that it was a typo and "from" was intended), and other readers chimed in, agreeing that it was confusing:
https://public-inbox.org/git/0102016b8d597569-c1f6cfdc-cb45-4428-8737-cb1bc30655d8-000000@eu-west-1.amazonses.com/#t
Quoted 7 lines
Quoted 4 lines
Let's rewrite that paragraph for clarity.
Inspired-by-a-patch-by Catalin Criste <[email protected]>Signed-off-by Johannes Schindelin <[email protected]>Thanks for picking this thread up again, I had already forgotten about it. The updated wording sounds like an improvement to me.
To me too. I would have just done s/form/become/ out of laziness and aiming for conciseness, but the new and separate sentence is good, too.
Thanks, both.
Quoted 23 lines
Quoted 23 lines
--- Documentation/git-stash.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)Documentation/git-stash.txt +3
-2@@ -87,8 +87,9 @@ The `--patch` option implies `--keep-index`. You can use save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: This option is deprecated in favour of 'git stash push'. It - differs from "stash push" in that it cannot take pathspecs, - and any non-option arguments form the message. + differs from "stash push" in that it cannot take pathspecs. + Instead, all non-option arguments are concatenated to form the stash + message. list [<options>]::Signature · 1 line
gitgitgadget