Author chris.jerdonek
Recipients asvetlov, brett.cannon, chris.jerdonek, docs@python, eli.bendersky, eric.araujo, ezio.melotti, georg.brandl, r.david.murray, sbt, terry.reedy, v+python
Date 2012-09-11.04:07:03
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1347336424.01.0.367320477664.issue15629@psf.upfronthosting.co.za>
In-reply-to
Content
> The reason is that Sphinx has extra facilities that allow docttests to work without having to have "boilerplate" code in places where doing so would disrupt the narrative flow.

Yes, this seems to be true.  Sphinx has a "testsetup" directive which lets you avoid adding boilerplate to interactive examples:

http://sphinx.pocoo.org/ext/doctest.html?#directive-testsetup

I did a quick search, though, and it looks like this is used in only 7 documentation files out of the 430+ -- one of which is library/turtle.rst. :)

Similarly, the "testcode" directive (a variant of the doctest format) seems to be used in just 5 files.  In any case, we could still benefit from running the doctests from regrtest that don't require use of testsetup.
History
Date User Action Args
2012-09-11 04:07:04chris.jerdoneksetrecipients: + chris.jerdonek, brett.cannon, georg.brandl, terry.reedy, ezio.melotti, eric.araujo, v+python, r.david.murray, eli.bendersky, asvetlov, docs@python, sbt
2012-09-11 04:07:04chris.jerdoneksetmessageid: <1347336424.01.0.367320477664.issue15629@psf.upfronthosting.co.za>
2012-09-11 04:07:03chris.jerdoneklinkissue15629 messages
2012-09-11 04:07:03chris.jerdonekcreate