Code review/Feedback needed for new extension

Christian Ebert blacktrash at gmx.net
Fri May 7 03:47:03 CDT 2010


* Sylvain Hamel on Friday, May 07, 2010 at 04:06:36 +0000
> [alias]
> pullupdate=hg macro pullupdate
> [macros]
> pullupdate=pull;update;
> 
>> Why all the whitespace? Nobody puts that many blank lines in real config files, so there's no need for them in the help. 
> 
> If I remove the whitespace in the docstring, then, on my Windows 7 PC, if I run
> 
> hg help macros
> 
> The help output is all on the same line:
> 
>     [macros] supermacro=log -l 5;stat purgex=revert -a;purge
> 
> I have to double all line breaks in the docstring to get `hg help` to output the right thing.

That's because the help is formatted with docutils and should
adhere to the reStructured Text (rst) conventions.

http://docutils.sourceforge.net/rst.html

Probably you want to do something like this to achieve a literal
block:

Configuration example::

    [alias]
    pullupdate=hg macro pullupdate
    [macros]
    pullupdate=pull;update;


Just look at some other docs in the Mercurial, compare the
effects and steal from there ;-)

c
-- 
theatre - books - texts - movies
Black Trash Productions at home: http://www.blacktrash.org/
Black Trash Productions on Facebook:
http://www.facebook.com/blacktrashproductions


More information about the Mercurial-devel mailing list