[PATCH] commit code cleanup

[John Arbash Meinel]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Robert Collins wrote:
> On Mon, 2007-05-28 at 16:31 +1000, Ian Clatworthy wrote:
>> +        :param strict: If true, don't allow a commit if the working
>> tree
>> +                       contains unknown files.
>> +
>> +        :param revprops: Properties for new revision
>>          :param local: Perform a local only commit.
>>          :param recursive: If set to 'down', commit in any subtrees
>> that have
>> -            pending changes of any sort during this commit.
>> +                          pending changes of any sort during this
>> commit.
>>          """ 
> 
> This formatting is inconsistent with the rest of bzr:
> 
>     :param FOO: long line that requires 
>         wrapping
> 
> is how we have been doing it. I dont really care which way we do it, but
> lets not change horses in a single file. I do have a slight preference
> for the current form because the indents are always the same amount and
> that makes it easier to read to me.
> 
> -Rob

Actually, epydoc requires:

:param foo: long line
    that is wrapped

It will complain if you try to do:

:param foo: long line
            that is wrapped

Or even

:param foo: long line
        that is wrapped

I'm pretty sure it requires an indentation of 4 characters.

I used to prefer the second form, but because of epydoc, I think we
should standardize on the former.

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (Darwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFGXLGRJdeBCYSNAAMRAtazAKDEeGUwQslGtSdn/LV/sNFsvIhvmgCgvzsv
nCabv1MW6NJKIhNzOPkepDU=
=+Vz7
-----END PGP SIGNATURE-----