Code review comment for lp:~spiv/bzr/lockcontention-pushing-tag-733350-2.3

Revision history for this message
Andrew Bennetts (spiv) wrote :

Martin Pool wrote:
> Review: Approve
> PEP8: docstrings ought to have just one sentence on the first line.
> (I guess you accidentally reflowed them.)

Changed (although the pydoctor output treats a first paragraph
identically to a first line, so the practical benefit seems low).

> I'd like a docstring mention for the new ivar.

Done (although pydoctor doesn't appear to notice that underscored ivar
names are private, probably because epydoc doesn't have a public/private
distinction here either? Anyway documenting things is good, and our
conventions are pretty clear and well-recognised even though we have
lots of exceptions like _format).

> You may want to wait for a second review in case someone knows of
> problem consequences.

Good idea. I'll wait. I hope there aren't any!

Thanks for the review!

« Back to merge proposal