# Documentation issue: git-stash examples

3 messages from 2017-05-25 to 2017-05-25. Participants: Adrian Forbes, Jeff King.
Thread: https://gitlist.dev/t/46040

## Adrian Forbes, 2017-05-25 09:52

Subject: Documentation issue: git-stash examples
Message-ID: <CAOJu4w-4eCkt9Co19BmyTQ7NF+rf23LU8ANCTCcmPP84efdjeA@mail.gmail.com>
URL: https://gitlist.dev/e/CAOJu4w-4eCkt9Co19BmyTQ7NF%2Brf23LU8ANCTCcmPP84efdjeA%40mail.gmail.com

```
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 King, 2017-05-25 18:30

Subject: Re: Documentation issue: git-stash examples
Message-ID: <20170525183037.tu7vaja25b7vgjfe@sigill.intra.peff.net>
URL: https://gitlist.dev/e/20170525183037.tu7vaja25b7vgjfe%40sigill.intra.peff.net
In-Reply-To: <CAOJu4w-4eCkt9Co19BmyTQ7NF+rf23LU8ANCTCcmPP84efdjeA@mail.gmail.com>

```
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 King, 2017-05-25 21:54

Subject: Re: Documentation issue: git-stash examples
Message-ID: <20170525215403.v5fzw7amicyftbgi@sigill.intra.peff.net>
URL: https://gitlist.dev/e/20170525215403.v5fzw7amicyftbgi%40sigill.intra.peff.net
In-Reply-To: <CAOJu4w-cghto=LAZKQPBDBHX=JOSbHGJiYawod+45_SzvhiuNg@mail.gmail.com>

```
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

```
