Author georg.brandl
Recipients Dmitry.Jemerov, JingCheng.LIU, docs@python, eric.araujo, ezio.melotti, georg.brandl, orsenthil, pitrou, r.david.murray, stutzbach, terry.reedy
Date 2010-09-03.22:45:22
SpamBayes Score 2.80756e-08
Marked as misclassified No
Message-id <1283553924.23.0.945278993936.issue9730@psf.upfronthosting.co.za>
In-reply-to
Content
Generally: +1 on making sure examples in the docs are up to date.  If someone wants to do the tedious work of making sure that a "make doctest" succeeds, I'm all for it, it may involve adding a few (in HTML output invisible) testsetup blocks.

Eric: I'm not sure what the difference between your methods 2 and 3 is :)

As Terry already mentioned, by far not all example code is covered by that, and I don't think there's anything we can do about it.  We can of course try converting more doc examples to doctest format, however:

a) for longer examples and especially function/class definitions this really hurts readability and usability (think copy/paste)

b) many examples are also not easily runnable (Tk is a good example, many more can be found in those for network services)
History
Date User Action Args
2010-09-03 22:45:24georg.brandlsetrecipients: + georg.brandl, terry.reedy, orsenthil, pitrou, stutzbach, ezio.melotti, eric.araujo, r.david.murray, Dmitry.Jemerov, docs@python, JingCheng.LIU
2010-09-03 22:45:24georg.brandlsetmessageid: <1283553924.23.0.945278993936.issue9730@psf.upfronthosting.co.za>
2010-09-03 22:45:22georg.brandllinkissue9730 messages
2010-09-03 22:45:22georg.brandlcreate