Code review comment for lp:~chipaca/ubuntuone-client/devices-tab

Revision history for this message
John Lenton (chipaca) wrote :

> Approving. I opened Bug #532841 for the "ugly" error thingy.
>
> Small fixes for docstrings:
>
> * First line should be next to the double-triple quotes.

I disagree; it looks ugly in the code, except for docstrings that are just one line, like

   """A docstring in a single line"""

although even there I think consistency with multi-line docstrings, plus the added readability due to the extra whitespace, makes the other form better.

WRT consistency with the PEP, PEP 257 says «The summary line may be on the same line as the opening quotes or on the next line.»

> * First line should be a one-liner follow up by a blank line.

yep, edited those down a little.

> * Line 183 says "dialo."

good catch!

> * Every line should be ended with a dot.

ok.

« Back to merge proposal