Added missing space and reformatted docstring

Martin Geisler mg at daimi.au.dk
Mon Aug 11 15:38:06 CDT 2008


Martin Geisler <mg at daimi.au.dk> writes:

> -        To reduce annotation cost,
> -        this returns fixed value(False is used) as linenumber,
> -        if "linenumber" parameter is "False".'''
> +        To reduce annotation cost, this returns fixed value (False is
> +        used) as linenumber, if "linenumber" parameter is "False".'''

What do people feel about documentation patches like this one and
would it be appreciated if I tried writing more docstrings?

I'm not talking about the mindless JavaDoc-like style where you write
repetitive stuff like "Returns the result.\n\n at return result: the
result.", but more some explanation for the central classes -- what
are they good for and how do they play together.

-- 
Martin Geisler

VIFF (Virtual Ideal Functionality Framework) brings easy and efficient
SMPC (Secure Multi-Party Computation) to Python. See: http://viff.dk/.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 188 bytes
Desc: not available
Url : http://selenic.com/pipermail/mercurial-devel/attachments/20080811/83f354f6/attachment.pgp 


More information about the Mercurial-devel mailing list