[PATCH 6 of 6 STABLE] doc: unify section level between help topics for TOC in generated documents

Matt Mackall mpm at selenic.com
Fri Apr 27 11:44:12 CDT 2012


On Thu, 2012-04-26 at 21:38 +0900, FUJIWARA Katsunori wrote:
> # HG changeset patch
> # User FUJIWARA Katsunori <foozy at lares.dti.ne.jp>
> # Date 1335443568 -32400
> # Branch stable
> # Node ID a60e7e24b3486a93f619559df576835776975875
> # Parent  5a697ab463387ab6e7c934765e7858730e8af97e
> doc: unify section level between help topics for TOC in generated documents
> 
> some help topics use "-" for top level underlining section mark.

I think this is a great idea, but I think we should have a discussion
about a standard hierarchy of markers first. I for one don't like
'""""""' as a section marker at all.

> http://mercurial.selenic.com/wiki/HelpStyleGuide#Sections

If you compare this page to:

http://mercurial.selenic.com/wiki/WikiStyleGuide

...you'll see that it's not actually a style guide at all and is more of
a syntax reference. Having an actual style guide for our help text (and
error message, etc.) would be great. We've just got a small piece of
that here:

http://mercurial.selenic.com/wiki/CodingStyle#Status_and_error_messages

-- 
Mathematics is the supreme nostalgia of our time.




More information about the Mercurial-devel mailing list