[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: Philip Martin <philip.martin_at_wandisco.com>
Date: Wed, 07 Mar 2012 12:48:41 +0000

Philip Martin <philip.martin_at_wandisco.com> writes:

> Greg Stein <gstein_at_gmail.com> writes:
>
>> Geez. Be smart, Philip. Obviously, that quoted content is dumb. 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? If we have to repeat default parameters in the
> docstring it it something we can get wrong, if we don't repeat them they
> can't be wrong. What do we gain?

Maybe what you want is that we follow some of PEP-257 but not all of it?
How should the docstring change?

    """Append CONTENTS to file DEST, optionally truncating it first.
       DEST is a relpath relative to the WC."""

-- 
uberSVN: Apache Subversion Made Easy
http://www.uberSVN.com
Received on 2012-03-07 13:49:12 CET

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