Comment inline below.<br><br><div class="gmail_quote">On Sun, May 2, 2010 at 1:25 PM, Michael Haupt <span dir="ltr"><<a href="mailto:mhaupt@gmail.com">mhaupt@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
Hi Casey,<br>
<div class="im"><br>
On Sun, May 2, 2010 at 10:12 PM, Casey Ransberger<br>
<<a href="mailto:casey.obrien.r@gmail.com">casey.obrien.r@gmail.com</a>> wrote:<br>
> I'd actually recommend that we worry about documenting the tests after<br>
> documenting the classes they test for several reasons.<br>
> - Tests are a form of documentation already. When I am looking for ways to<br>
> use a class, and the class comment is insufficient, I'll often look at<br>
> whatever tests are available.<br>
<br>
</div>I usually get nervous when people say code is documentation. That may<br>
be true for the experienced, for all others, it is not. So that's not<br>
a reason to postpone documenting tests in my opinion.<br>
<div class="im"><br></div></blockquote><div><br></div><div>Hey, me too! But in the case of tests, I actually disagree. I'm not arguing that we shouldn't document our test classes, but I will point out that *a test is an example usage* and *examples are documentation.* </div>
<div><br></div><div>One thing I really enjoy, actually, is when a class comment says something like "Please see the test cases in FooTests for some concrete examples."</div><div><br></div><div>This is totally off topic, but I think this is kind of cool (and totally pink-plane thinking:)</div>
<div><br></div><div><a href="http://cukes.info/">http://cukes.info/</a></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div class="im"></div><big snip><br>
<br>
Best,<br>
<font color="#888888"><br>
Michael<br>
<br>
</font></blockquote></div><br><br clear="all"><br>-- <br>Casey Ransberger<br>