classification
Title: make doctest fails on 2.7 release notes
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Jelle Zijlstra, berker.peksag, docs@python, martin.panter, orsenthil, python-dev
Priority: normal Keywords: patch

Created on 2016-06-04 00:04 by Jelle Zijlstra, last changed 2016-06-05 05:24 by orsenthil. This issue is now closed.

Files
File name Uploaded Description Edit
no27doctests.patch Jelle Zijlstra, 2016-06-04 00:04 review
issue27202-revised.patch Jelle Zijlstra, 2016-06-05 04:53 reverts conf.py change, skips doctests instead review
Messages (11)
msg267190 - (view) Author: Jelle Zijlstra (Jelle Zijlstra) * (Python triager) Date: 2016-06-04 00:04
Running `make doctest` in the Doc/ repository of master fails on the 2.7 release notes. This patch excludes these files from `make doctest`, because it doesn't seem worth it to try to get these running in Python 3.
msg267214 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-06-04 01:06
Ignore my message; I was thinking of something different :)

I presume you are running something like the following, which seems to smoke-test the examples in the documentation:

make -C Doc doctest
msg267216 - (view) Author: Jelle Zijlstra (Jelle Zijlstra) * (Python triager) Date: 2016-06-04 01:18
Yes, I've been attempting to get that make to fully succeed.
msg267220 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-06-04 01:46
Since I stuck my neck out, I will say that this seems reasonable to me. We could probably still run doctest in the actual 2.7 branch to detect any errors there.
msg267370 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-06-05 03:53
New changeset 70af472451cb by Senthil Kumaran in branch '3.5':
issue27202 - Exclude 2.x release notes from python3 make doctests.
https://hg.python.org/cpython/rev/70af472451cb

New changeset 2bb806539ca6 by Senthil Kumaran in branch 'default':
[merge from 3.5] - issue27202 - Exclude 2.x release notes from python3 make doctests.
https://hg.python.org/cpython/rev/2bb806539ca6
msg267371 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2016-06-05 03:54
Thanks for your contribution, Jelle.
msg267372 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2016-06-05 04:03
Perhaps it would be better to exclude all files in Doc/whatsnew.
msg267374 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2016-06-05 04:33
By the way, after this I'm getting the following warnings:

/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.7'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.6'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.5'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.4'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.3'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.2'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.1'
/Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.0'
msg267376 - (view) Author: Jelle Zijlstra (Jelle Zijlstra) * (Python triager) Date: 2016-06-05 04:38
Yes, I realized this patch is wrong: it excludes the 2.7 release notes from all make steps, not just `make doctest`.

The attached patch reverts the conf.py change and instead uses directives to skip most doctests in the 2.7 release notes. The other 2.x release notes have no failing doctests.
msg267385 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-06-05 05:23
New changeset 378c1d09b256 by Senthil Kumaran in branch '3.5':
issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6)
https://hg.python.org/cpython/rev/378c1d09b256

New changeset 31573473a50e by Senthil Kumaran in branch 'default':
[merge from 3.5] - issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6)
https://hg.python.org/cpython/rev/31573473a50e
msg267386 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2016-06-05 05:24
Addressed the problem with the previous commit.
History
Date User Action Args
2016-06-05 05:24:06orsenthilsetstatus: open -> closed
resolution: fixed
messages: + msg267386
2016-06-05 05:23:23python-devsetmessages: + msg267385
2016-06-05 04:53:53Jelle Zijlstrasetfiles: + issue27202-revised.patch
2016-06-05 04:38:34Jelle Zijlstrasetstatus: closed -> open
resolution: fixed -> (no value)
messages: + msg267376
2016-06-05 04:33:06berker.peksagsetmessages: + msg267374
2016-06-05 04:03:23berker.peksagsetnosy: + berker.peksag
messages: + msg267372
2016-06-05 03:54:15orsenthilsetstatus: open -> closed

type: behavior

nosy: + orsenthil
messages: + msg267371
resolution: fixed
stage: patch review -> resolved
2016-06-05 03:53:43python-devsetnosy: + python-dev
messages: + msg267370
2016-06-04 01:46:25martin.pantersetstage: patch review
messages: + msg267220
versions: + Python 3.5
2016-06-04 01:18:02Jelle Zijlstrasetmessages: + msg267216
2016-06-04 01:06:21martin.pantersetmessages: + msg267214
2016-06-04 01:04:04martin.pantersetmessages: - msg267213
2016-06-04 01:02:02martin.pantersetnosy: + martin.panter
messages: + msg267213
2016-06-04 00:48:01Jelle Zijlstralinkissue27200 dependencies
2016-06-04 00:04:06Jelle Zijlstracreate