On May 31, 2012 4:45 PM, "Julian Foad" <julianf...@btopenworld.com> wrote: > > 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.
Not a problem. As long as we move towards the PEP styles in time. I consider using the standardized docstrings as being similar to the doxygen rules (and what we've established for internal docstrings). Thx, -g
