Message 125906 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	belopolsky
Recipients	belopolsky, docs@python, eric.araujo, lukasz.langa, terry.reedy
Date	2011-01-10.17:37:27
SpamBayes Score	3.7065337e-07
Marked as misclassified	No
Message-id	<AANLkTintK_9ueQ4=632FsqO_TDCNue+qWe7oUB4xFmmJ@mail.gmail.com>
In-reply-to	<1294606370.8.0.33298496606.issue10225@psf.upfronthosting.co.za>

Content
On Sun, Jan 9, 2011 at 3:52 PM, Terry J. Reedy <report@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.

On Sun, Jan 9, 2011 at 3:52 PM, Terry J. Reedy <report@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.

History
Date	User	Action	Args
2011-01-10 17:37:29	belopolsky	set	recipients: + belopolsky, terry.reedy, eric.araujo, docs@python, lukasz.langa
2011-01-10 17:37:27	belopolsky	link	issue10225 messages
2011-01-10 17:37:27	belopolsky	create