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

Cory Dodt corydodt at gmail.com
Fri Sep 22 11:12:20 EDT 2006


   * 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?

C

On 9/22/06, glyph at divmod.com <glyph at divmod.com> wrote:
>
> On Fri, 22 Sep 2006 08:58:36 -0400, Jean-Paul Calderone <
> exarkun at divmod.com> wrote:
>
> >Docstring?
>
> I'd like to direct all reviewers' attention at this point to the excellent
> wiki page that Chris and JP wrote a little while ago:
>
>     http://twistedmatrix.com/trac/wiki/ReviewProcess
>
> Especially to this section:
>
> """
>
>   A reviewer must reject a set of changes in any of the following
> circumstances:
>
>     * The test suite fails on any of the supported* platforms as a result
> of the changes.
>     * The changes alter the behavior of code in a way which is not tested.
>     * The changes add new behavior without adding test coverage for that
> behavior.
>     * 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.
>     * The changes modify the behavior of a documented API without updating
> the documentation.
>     * The changes violate the coding standard.
>
> """
>
> _______________________________________________
> 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: http://twistedmatrix.com/pipermail/twisted-python/attachments/20060922/25f78d5f/attachment.htm 


More information about the Twisted-Python mailing list