[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r1297921 - /subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Wed, 7 Mar 2012 13:36:57 +0000 (GMT)

Philip Martin wrote:

>> Greg Stein <gstein_at_gmail.com> writes:
>>> I'm talking about format. Specifically not following the basic
>>> rule of "one line summary. One blank line. Details." Julian's
>>> change is missing the blank lines, which many tools parse.
>>>
>>> That's what I don't understand.  Are we expecting people to use
>>> tools to parse these docstrings?  [...]
[...]
>
> So which bits of PEP-257 do we follow?  [...]

Sounds like Greg's really just asking for a blank line after the summary.  I'm happy to start doing that in future; I think it can be quite a helpful habit (also, or more so, in our C code).

FWIW I wasn't changing doc strings from single-line to multi-line in this commit, I was just adding some missing info in a style consistent with surrounding code AFAIK.

- Julian
Received on 2012-03-07 14:37:39 CET

This is an archived mail posted to the Subversion Dev mailing list.