On Jun 11, 2010, at 7:57 AM, Andrey Novoseltsev wrote:

On Jun 11, 2:46 am, Florent Hivert <florent.hiv...@univ-rouen.fr>
wrote:
They can go in separate files, files which, for example, are not
included in the reference manual. The file sage/homology/ tests.py is an example. Each function should have doctests (so the goal is still 100% coverage), but it's not a big deal to relegate lots of technical
test to less visible places.

Personally, I would much rather put the relevant tests locally right in the docstring and hide them from the documentation generators. Especially as TESTS blocks often test corner cases or other technicalities relevant to
that specific function.

+1 Sphinx can certainly handles hiding of TESTS if asked to.

Florent

That would be so awesome! In principle, I probably should implement
it, since I really want it, but in practice it will be time consuming
with my (lack of) knowledge of Sphynx and I already got quite a few
other things going. But if someone implements it, I will be very-very-
very happy!

That was the original goal of the TESTS block being distinct from EXAMPLES. I don't think it's a matter of if, rather when.

- Robert


--
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

Reply via email to