Test coverage c extension doc fix
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
Currently in the test coverage section, specifically 5.2.1.4, it mentions building the C extension for coverage.py. For a while now coverage.py has come with the C extension by default, so this step is almost never required (see here: https://coverage.readthedocs.io/en/coverage-5.1/install.html#c-extension).
I'm thinking it would be worth mentioning in the guide that installing the C extension is only required if 'coverage --version' says 'Without C extension'.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the test coverage section, specifically subsection 5.2.1.4, and compare its C-extension instruction with the linked coverage.py documentation. Done means the guide explains that installing the extension is only needed when coverage --version reports “Without C extension”.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100