On Jun 2, 2007, at 8:44 AM, Michel wrote:

> There is something I have not fully understood yet.
> If I understand correctly doctests appears in the documentation as
> "examples".
> Now many doctests deal with obscure borderline cases (as regression
> tests) so they are uninteresting as examples. Is there a way to hide
> such doctests from the documentation?

I've wondered about this issue before. One solution is to simply put  
the extra doctests somewhere else "out of the way". They could live  
in global scope in the same file, or perhaps even in a different  
file. The most important thing is that they get run when "sage -t" is  
run. (Ideally the function documentation should give a pointer to  
them as well.)

But as far as I know we don't have a standardised approach for this.  
It would be good if we did. As SAGE matures I hope the doctest  
coverage gets *much* more systematic and complete, especially with  
regard to border cases, and as you point out, we might not always  
want this cluttering the examples section.

david


--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://sage.scipy.org/sage/ and http://modular.math.washington.edu/sage/
-~----------~----~----~----~------~----~------~--~---

Reply via email to