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.

Title: Code coverage documentation is out-of-date.
Type: enhancement Stage: resolved
Components: Devguide Versions:
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: brett.cannon, doerwalter, eric.araujo, ezio.melotti, hmcc, matrixise, ned.deily, python-dev, willingc
Priority: normal Keywords: patch

Created on 2014-04-30 15:07 by matrixise, last changed 2022-04-11 14:58 by admin. This issue is now closed.

File name Uploaded Description Edit
issue21400-1.patch hmcc, 2014-09-01 08:59
Messages (10)
msg217622 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-30 15:07
In the section "Increase Test Coverage" of the DevGuide :

You can read this paragraph where there is a url for a website, but the website is out-of-date and don't reflect the right version of Python.

Choosing what module you want to increase test coverage for can be done in a
couple of ways.
A third-party website at provides an
overall view of how good coverage is for various modules (you will want to
focus on those in the ``Lib`` directory as those are the pure Python modules
from Python's stdlib, and thus easier to work with than the C extension
modules). But since this is a third-party site we cannot promise that it will
always be accessible or have useful information (i.e., be working properly).

Python code coverage
Generated at 2013-08-14 08:28:40

Last commit at 2013-08-14 03:34:49 by Raymond Hettinger

Changeset identification hash ac2f59a6637f0cc69c4a5541195ce752cf34952a

Local revision number 85168

Two options, remove the link or update the site.
msg217623 - (view) Author: Walter Dörwald (doerwalter) * (Python committer) Date: 2014-04-30 15:42
The cronjob that produces this information has been deactivated, because it currently produces broken output. The code for that job is available from here:

It would be great to have up to date coverage info for Python again, but I don't have time to work on that. Perhaps someone can combine this code and Ned Batchelder coverage script to implement a new coverage site (that includes coverage info for C modules).

However for now I think this link should be removed.
msg217626 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-30 16:01
Ok thanks for your feedback about your script. Where can I find the scripts of Ned?

Thank you
msg217768 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-05-02 17:56
I think Walter is referring to Ned's project, i.e. the standard coverage module that you get with pip install coverage.
msg226221 - (view) Author: Heather McCartney (hmcc) * Date: 2014-09-01 08:59
Here's a patch with a suggestion for the new text, with the part about the code coverage website removed.

Once that part was gone, I found the remainder slightly easier to read when the options were presented the other way around, so the simpler (although slower) option to run all the tests with coverage appears first. But I'm happy to change this (or anything else) if you feel that would be better.
msg240790 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-13 22:30
Patch applies cleanly. The out of date link has been removed.
+1 ready for a core dev to merge.
msg240796 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-04-13 22:50
New changeset 24536e980c9e by Ned Deily in branch 'default':
Issue #21400: Update the code coverage section to remove out-of-date
msg240798 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2015-04-13 22:55
Done.  Thanks for the patch, Heather.  (By the way, if you plan to contribute more changes, please sign the PSF Contributor Form as described here:
msg240864 - (view) Author: Heather McCartney (hmcc) * Date: 2015-04-14 10:10
You're welcome! Thanks for the feedback, I've signed the PSF Contributor Form.
msg240866 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-14 10:48
Thanks Heather for filing the PSF contribution form as well as the patch. I hope you will continue improving Python's documentation in the future :)
Date User Action Args
2022-04-11 14:58:03adminsetgithub: 65599
2015-04-14 10:48:06willingcsetmessages: + msg240866
2015-04-14 10:10:38hmccsetmessages: + msg240864
2015-04-13 22:55:34ned.deilysetstatus: open -> closed

nosy: + ned.deily
messages: + msg240798

resolution: fixed
stage: commit review -> resolved
2015-04-13 22:50:55python-devsetnosy: + python-dev
messages: + msg240796
2015-04-13 22:30:47willingcsetnosy: + willingc

messages: + msg240790
stage: patch review -> commit review
2014-11-01 22:23:43ezio.melottisettype: enhancement
stage: patch review
2014-09-01 08:59:42hmccsetfiles: + issue21400-1.patch

nosy: + hmcc
messages: + msg226221

keywords: + patch
2014-05-02 17:56:20eric.araujosetnosy: + eric.araujo
messages: + msg217768
2014-05-01 17:23:06pitrousetnosy: + ezio.melotti
components: + Devguide
2014-05-01 14:51:12brett.cannonsetnosy: + brett.cannon
2014-04-30 16:01:42matrixisesetmessages: + msg217626
2014-04-30 15:42:32doerwaltersetnosy: + doerwalter
messages: + msg217623
2014-04-30 15:07:54matrixisecreate