Author ezio.melotti
Recipients aliles, asvetlov, brett.cannon, chris.jerdonek, docs@python, eli.bendersky, eric.araujo, ezio.melotti, georg.brandl, pitrou, r.david.murray, sbt, terry.reedy, v+python
Date 2012-09-17.12:43:53
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1347885834.34.0.581638279567.issue15629@psf.upfronthosting.co.za>
In-reply-to
Content
> Documentation examples are meant to be read, not executed

I agree, but several of them already run, and others run with the addition of doctests directives (that are hidden in the html output).  If the code needs to be changed in a way that is less readable, the test can just be skipped.

> Furthermore, spreading unit tests in the doc files instead of Lib/test
> files will make maintenance of tests more tedious as well.

Tests should be kept in Lib/test, this is mostly to make sure that the examples are correct.  The examples in the docs should still be written with the goal to be clear for the user -- being valid doctests is a secondary goal.
History
Date User Action Args
2012-09-17 12:43:54ezio.melottisetrecipients: + ezio.melotti, brett.cannon, georg.brandl, terry.reedy, pitrou, eric.araujo, v+python, r.david.murray, eli.bendersky, asvetlov, chris.jerdonek, docs@python, sbt, aliles
2012-09-17 12:43:54ezio.melottisetmessageid: <1347885834.34.0.581638279567.issue15629@psf.upfronthosting.co.za>
2012-09-17 12:43:53ezio.melottilinkissue15629 messages
2012-09-17 12:43:53ezio.melotticreate