classification
Title: Failing doctests in Doc/faq/programming.rst
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Jelle Zijlstra, docs@python, martin.panter, orsenthil, python-dev
Priority: normal Keywords: patch

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

Files
File name Uploaded Description Edit
doctests-faq.patch Jelle Zijlstra, 2016-06-04 15:44 review
Messages (5)
msg267197 - (view) Author: Jelle Zijlstra (Jelle Zijlstra) * (Python triager) Date: 2016-06-04 00:19
Patch attached. Added testsetup for the shared A variable and skipped doctests that rely on the return value of id().
msg267219 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-06-04 01:37
make -C Doc/ suspicious fails:

WARNING: [faq/programming:1177] ".. testsetup:" found in ".. testsetup::"

Suspicious check complete; look for any errors in the above output or in build/suspicious/suspicious.csv.  If all issues are false positives, append that file to tools/susp-ignored.csv.
make: *** [suspicious] Error 1
[Exit 2]
msg267257 - (view) Author: Jelle Zijlstra (Jelle Zijlstra) * (Python triager) Date: 2016-06-04 15:44
Thanks for teaching me about `make suspicious`. The attached patch fixes the issue.

This doesn't fix all failures in the file but it gets us closer.
msg267368 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-06-05 03:08
New changeset fea14da8442d by Senthil Kumaran in branch '3.5':
Issue27203 - Fix doctests Doc/faq/programming.rst.
https://hg.python.org/cpython/rev/fea14da8442d

New changeset 4a072fff6945 by Senthil Kumaran in branch 'default':
[merge from 3.5] - Issue27203 - Fix doctests Doc/faq/programming.rst.
https://hg.python.org/cpython/rev/4a072fff6945
msg267369 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2016-06-05 03:12
Thanks for the patch, Jelle Zijlstra. 

We don't have warnings in Doc/faq/programming.rst now, and this issue was specific to fix the doctests for it. I find it complete. Closing this issue.
History
Date User Action Args
2016-06-05 03:12:22orsenthilsetstatus: open -> closed

type: behavior

nosy: + orsenthil
messages: + msg267369
resolution: fixed
stage: resolved
2016-06-05 03:08:15python-devsetnosy: + python-dev
messages: + msg267368
2016-06-04 15:44:19Jelle Zijlstrasetfiles: + doctests-faq.patch

assignee: docs@python
components: + Documentation
versions: + Python 3.6
nosy: + docs@python

messages: + msg267257
2016-06-04 15:43:46Jelle Zijlstrasetfiles: - faqdoctests.patch
2016-06-04 01:37:47martin.pantersetnosy: + martin.panter
messages: + msg267219
2016-06-04 00:48:01Jelle Zijlstralinkissue27200 dependencies
2016-06-04 00:19:52Jelle Zijlstracreate