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.<br><br>Thanks!<br><br>C<br><br><div><span class="gmail_quote">
On 9/22/06, <b class="gmail_sendername"><a href="mailto:glyph@divmod.com">glyph@divmod.com</a></b> <<a href="mailto:glyph@divmod.com">glyph@divmod.com</a>> wrote:</span><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
On Fri, 22 Sep 2006 08:12:20 -0700, Cory Dodt <<a href="mailto:corydodt@gmail.com">corydodt@gmail.com</a>> wrote:<br>> * The changes modify public APIs which are undocumented (ie, a function<br>>which has no docstring is modified, or a class which has no docstring has
<br>>methods added to it) without adding documentation.<br>><br>>Since when are tests public APIs?<br><br>Hmm, good point, I guess "public API" is a bit misleading there.<br><br>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.
<br><br>I'll update that document a bit later.<br><br>_______________________________________________<br>Twisted-Python mailing list<br><a href="mailto:Twisted-Python@twistedmatrix.com">Twisted-Python@twistedmatrix.com</a>
<br><a href="http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python">http://twistedmatrix.com/cgi-bin/mailman/listinfo/twisted-python</a><br></blockquote></div><br>