"doctest" and corner cases (was: [Zope-dev] Re: zope.sendmail Retry fixes and new state machine.)

Dieter Maurer dieter at handshake.de
Thu Mar 13 15:44:28 EDT 2008


Stephan Richter wrote at 2008-3-10 22:37 -0500:
>In my opinion it is as necessary to describe corner cases with words. In fact, 
>corner cases often need even more documentation, because they are not 
>obvious.

It depends.

Many corner cases are obvious when one looks at the implementation.

If they are not, I prefer words inline in the implementation (as
a source code comment) over words separated in a test (also
the test may specify in some way that it checks the specifiy
corner case).



-- 
Dieter


More information about the Zope-Dev mailing list