[PATCH] Bugzilla: More doc fixes

Martin Geisler mg at aragost.com
Wed Apr 6 09:18:47 CDT 2011


Christian Ebert <blacktrash at gmx.net> writes:

> * Jim Hague on Wednesday, April 06, 2011 at 11:30:57 +0100
>> # HG changeset patch
>> # User Jim Hague <jim.hague at acm.org>
>> # Date 1302085808 -3600
>> # Node ID 3b4025dcb223e8ec513b3c85e8425493bb7e2b4f
>> # Parent  1aea86673deee9f382347377e398fbfc62c508ea
>> bugzilla: more documentation formatting fixups
>
> <snip>
>
>> -  See also the [usermap] section.
>> +  See also the ``[usermap]`` section.
>> 
>> The ``[usermap]`` section is used to specify mappings of Mercurial
>> committer email to Bugzilla user email. See also ``bugzilla.usermap``.
>
> Are there any formatting guidelines around? atm, things like
> [section] etc. are done inconsistently.

Yes, it's not standardized. I bet we have all three variants, here shown
as they are rendered by minirst and by Docutils:

  ASCII      HTML

  [foo]      [foo]
  "[foo]"    <tt>[foo]</tt>
  "foo"      <tt>foo</tt>

The mismatch between quotes in the terminal and monospace font in the
HTML output is kind of silly and when we get a smarter minirst, then I
would like it to render ``foo`` with emphasis instead of with quotes.

As for which of the three forms to use, then I think ``[foo]`` is the
one users will like best, though I feel that the third option is
slightly more correct since the section is called "foo", and "[foo]"
just happens to be the syntax you use when you use the section.

-- 
Martin Geisler

aragost Trifork
Professional Mercurial support
http://mercurial.aragost.com/kick-start/


More information about the Mercurial-devel mailing list