[PATCH] Documentation: Quote ~(s) causing subscript
- From
Thomas Rast <trast@student.ethz.ch>
- Date
- Sep 15, 2008, 09:19 UTC
- Message-ID
- <1221470398-8698-1-git-send-email-trast@student.ethz.ch>
This is actually not a series, but a choice. I noticed that git-bundle.html has a stray subscript in the first paragraph of 'Specifying References', so here are two options:
* Documenation: git-bundle: quote tildes that cause subscript
The minimal-impact change. Quotes just enough tildes in that paragraph to avoid the subscript.
* Documentation: replace [^~] with escapes everywhere
The global change. Quotes all tildes and carets to avoid any future confusion.
I like the global change better, because any tilde or caret is a possible future pitfall: it will trigger a sub/superscript as soon as a matching delimiter is added within the same paragraph. But of course it makes the ascii non-markup less readable as plain text.
Searching through history and list archives didn't exactly help: as early as babfaba (Fix usage of carets in git-rev-parse(1), 2005-10-05), the {caret} was established. However, in a thread on precisely the paragraph in git-bundle.txt I'm trying to fix,
http://thread.gmane.org/gmane.comp.version-control.git/50761
the discussion turned to trying to figure out a consistent asciidoc behaviour -- and from there, style guide -- but died. The patch apparently never made it into git.git in either the \~ or the {tilde} form.
- Thomas