Bugzilla extension doc changes

[Martin Geisler]

Jim Hague <jim.hague at acm.org> writes:

Hi Jim,

I'm putting the mailinglist on Cc since I think this could be
interesting for others.

> Thanks for the changes you've been making correcting my reST messups
> in the bugzilla extension.

No problem! Thanks for the patches :-)

> In my most recent change I'd thought about using a field list instead
> of a verbatim block. I went with the verbatim block after looking at
> the output from 'hg help bugzilla', but there wasn't much in it.

Yeah, I see -- in the command line output a verbatim block is often a
nice way to format some lines in a table-like manner. And you can often
not see the difference between a field list and a verbatim block since
it's all monospaced text anyway.

It's a balance between using the "semantically right" markup and making
it look nice in the console. If the field lists look weird, then I'm
fine with using a verbatim block to get better layout, though it does
break for narrow terminals.

> I've got some more changes in the pipeline, so to try and avoid
> causing you more work, can I ask - what do you use for
> checking/viewing the reST output?

I simply run 'make doc'. Compared to 'make test-gendoc.t', this lets me
easily inspect the doc/hg.1.gendoc.txt file to see what is going on if I
cannot figure it out from the error message directly.

-- 
Martin Geisler

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