[Zope-dev] Why I dislike narrative doctests

Christian Theune ct at gocept.com
Fri Apr 25 02:01:06 EDT 2008


On Thu, Apr 24, 2008 at 04:07:12PM -0400, Jim Fulton wrote:
> - If a file is documentation and a test, make sure it is good  
> documentation. In that case, documentation comes first. Don't add so  
> many tests that it ruins the documentation.
>
> - Test edge cases in separate tests.  These are typically short-ish  
> strings in test modules.
>
> - A variation is to have a narrative that doesn't try hard to be  
> documentation.  The narrative can be convenient, up to a point, even in a 
> test.  These should be clearly marked as not being documentation.

Thanks for summing that up.

-- 
gocept gmbh & co. kg - forsterstrasse 29 - 06112 halle (saale) - germany
www.gocept.com - ct at gocept.com - phone +49 345 122 9889 7 -
fax +49 345 122 9889 1 - zope and plone consulting and development


More information about the Zope-Dev mailing list