Comment #4 on issue 688 by [email protected]: generate documentation from tests
http://code.google.com/p/sympy/issues/detail?id=688

Isn't it better to just test the documentation, like we already do?

To me there should be a clear separation between documentation and tests, because they serve different purposes. Documentation examples should demonstrate usage, and tests should test functionality. Once you try to start making your examples tests or your tests examples, you become less effective in the respective goals.

We already have this issue sometimes where people want to use doctests as "tests", resulting in less instructive examples. Doctests should really just be thought of as examples that happen to be tested, and so I think that the tests should also be thought of as tests that happen to be usable as examples in many situations.

--
You received this message because you are subscribed to the Google Groups 
"sympy-issues" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sympy-issues?hl=en.

Reply via email to