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

Re: [PATCH v2] Update documentation for stripspace

From
Junio C Hamano <gitster@pobox.com>
Date
Dec 12, 2011, 23:41 UTC
Message-ID
<7vwra1z7bg.fsf@alter.siamese.dyndns.org>
In-Reply-To
<1323728909-7847-1-git-send-email-conrad.irwin@gmail.com>
Conrad Irwin <conrad.irwin@gmail.com> writes:
> ...
> I've moved the *NOTE* into a SEE ALSO section where I think it reads
> less opinionatedly ― is that better?
I think it looks a lot worse.

At least your original hinted that some people may confuse the two and the NOTE was there for such people; other people who would not even dream of such a confusion won't find the existence of the note a "Huh?". But the updated patch with a link in SEE ALSO section without any explanation would be a definite "Huh?" for those of us who find that stripspace does not have anything to do with what "apply --whitespace=fix" does.

The new example section looks good. Perhaps we can just drop the extra SEE ALSO and resurrect the *NOTE* from your v1 patch.

Thanks.
Previous: Conrad IrwinNext: Conrad Irwin
Message 4 of 6 in “Update documentation for stripspace”
  1. Update documentation for stripspaceConrad Irwin, Dec 12, 2011
  2. Junio C HamanoDec 12, 2011
  3. Update documentation for stripspaceConrad Irwin, Dec 12, 2011
  4. Junio C HamanoDec 12, 2011
  5. Update documentation for stripspaceConrad Irwin, Dec 12, 2011
  6. Frans KlaverDec 13, 2011

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.