[Twisted-Python] Re: [Twisted-commits] r18220 - Make tests clean up after themselves

[Cory Dodt]

I'm all for having more documentation.  When I reviewed that bug I went by
the strictest interpretation of ReviewProcess, which it seems wasn't clear.
I'm glad it'll get clarified.

Thanks!

C

On 9/22/06, glyph at divmod.com <glyph at divmod.com> wrote:
>
> On Fri, 22 Sep 2006 08:12:20 -0700, Cory Dodt <corydodt at gmail.com> wrote:
> >   * The changes modify public APIs which are undocumented (ie, a
> function
> >which has no docstring is modified, or a class which has no docstring has
> >methods added to it) without adding documentation.
> >
> >Since when are tests public APIs?
>
> Hmm, good point, I guess "public API" is a bit misleading there.
>
> Tests also need docstrings to explain what they're testing, and what code
> they're supposed to cover.  The test docstrings need to explain the verified
> constraints of the public API, or to explicitly say "this is not testing a
> public API" - although the vast majority of tests are verifying at least
> some behavior of a public API, although not directly.
>
> I'll update that document a bit later.
>
> _______________________________________________
> Twisted-Python mailing list
> Twisted-Python at twistedmatrix.com
> http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: </pipermail/twisted-python/attachments/20060922/3c2f7262/attachment.html>