Re: svn commit: r1344825 - in /subversion/trunk/tools/dev/mergegraph: mergegraph.py save_as_sh.py

I (Julian Foad) wrote:

> Greg Stein wrote:
>>> +def command(out, cmd, *args):
>>> +  """Write the shell command CMD with the arguments ARGS to the file-like
>>> +     object OUT."""
>> Please review my earlier comments about standard docstring formatting in
>> Python. More specifically, PEP 8. (Google it)
>
> OK, r1344888 for 'most
> importantly, the """ that ends a multiline docstring should be
> on a line by itself [...]'.  Anything further will have to wait till another
> day.

Let me add a few more words here.  I support efforts to both standardize and raise the usefulness of doc strings.  I just haven't yet spent the time to read PEP 257 (being the relevant one) in full, digest it into my Python-commenting brain-space, decide what subset of its suggestions are appropriate for us to use in scripts like these, and go back and change them.

- Julian
Received on 2012-05-31 22:45:56 CEST