[issue10225] Fix doctest runable examples in python manual
Alexander Belopolsky
report at bugs.python.org
Mon Jan 10 18:37:29 CET 2011
Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:
On Sun, Jan 9, 2011 at 3:52 PM, Terry J. Reedy <report at bugs.python.org> wrote:
> .. It would be nice to get the fixes into 3.2.
Yes, it would be nice, but I don't have a 3.2 patch (yet). As you can
see from my last comment, I ran into a bug in the alpha version of
sphinx that I used to validate py3k docs.
> What sort of feedback do you want? Proofreading of text? Recheck of doctest?
>
All of the above. Some of the fixes may be at the expense of
readability. I would appreciate feedback in the instances when human
and computer reader's interests are in conflict. Some examples are
"fixed" by excluding them from being checked. Better ideas are
welcome.
> Does sphinx suppress doctest comments like
> #doctest: +IGNORE_EXCEPTION_DETAIL
> ?
Yes.
>
> doctest.testfile("C:/programs/PyDev/py32/Doc/howto/sorting.rst", module_relative = False)
> fails 23 of 37 attempts, so improvement is needed ;-).
You cannot run documentation examples with a plain doctest. You have
to use sphinx-build.
----------
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10225>
_______________________________________
More information about the Python-bugs-list
mailing list