git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Documentation issue: git-stash examples

From
Jeff King <peff@peff.net>
Date
May 25, 2017, 18:30 UTC
Message-ID
<20170525183037.tu7vaja25b7vgjfe@sigill.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:
Show 8 quoted lines
> 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
Previous: Adrian ForbesNext: Jeff King
Message 2 of 3 in “Documentation issue: git-stash examples”
  1. Adrian ForbesMay 25, 2017
  2. Jeff KingMay 25, 2017
  3. Jeff KingMay 25, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.