threads / discuss / 46040
Subject: Documentation issue: git-stash examples
Some of the example commands in git-stash documentation should be written as comments rather than actual commands: https://cloud.githubusercontent.com/assets/24915363/26444394/5cf6a754-4190-11e7-845e-135288c8916e.png
For example, `$ edit emergency fix` should be `# ... edit emergency fix ...` like the other comments in the section.
It could be misleading for novices.
Adrian (github: @Solder-Soldier)
Jeff KingRe: Documentation issue: git-stash examples
On Thu, May 25, 2017 at 09:52:42PM +1200, Adrian Forbes wrote:
> Some of the example commands in git-stash documentation should be > written as comments rather than actual commands: > https://cloud.githubusercontent.com/assets/24915363/26444394/5cf6a754-4190-11e7-845e-135288c8916e.png > > For example, `$ edit emergency fix` should be `# ... edit emergency > fix ...` like the other comments in the section. > > It could be misleading for novices.
Yeah, I think that's a good idea. Do you want to try your hand at a patch?
-Peff
Jeff KingRe: Documentation issue: git-stash examples
On Fri, May 26, 2017 at 08:37:41AM +1200, Adrian Forbes wrote:
> Yep, but how do I send it back to you? As a mail attachment?
Usually you'd send it to the list, with the commit message in the body and the patch inline below, as generated by "git format-patch".
Unfortunately gmail is notorious for corrupting whitespace in message bodies. You can use git-send-email to send the mails (but you'll need to configure your gmail smtp information; see the EXAMPLE section of "git help send-email").
Alternatively, you can make a pull request to https://github.com/git/git and then send it to the list via https://submitgit.herokuapp.com/.
-Peff