Code review comment for lp:~spiv/bzr/hooks-refactoring

Revision history for this message
Martin Pool (mbp) wrote :

On 5 October 2010 10:55, Andrew Bennetts <email address hidden> wrote:
> In this instance, your proposed one-liner is good enough for me, so let's do
> that.
>
> In general, I don't bend over backwards to make the summary sentence fit on one
> line: sometimes things really are a bit complex and a short, vague “does stuff”
> that forces you to read the body seems to do the reader more of a disservice a
> slightly-more-than-one-line initial sentence.
>
> It's probably worth checking what pydoc and epydoc do with these overrunning
> sentences...  As a core developer I'm primarily reading them in the
> source directly, but that might not be true for authors of code using bzrlib.

I agree with all that. I stick to it in the unverifiied belief it
might prevent epydoc printing truncated sentences as summaries. It's
not a big deal, just something I noticed.

--
Martin

« Back to merge proposal