python / python/devguide

Missing Windows step for installing coverage

Open
#336 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

In /coverage/ section 5.2.1.1
When installing coverage on Windows, the second command step can not be used:

source ../cpython-venv/bin/activate

Instead, there should probably be some mention of the proper step:

..\cpython-venv\Scripts\activate.bat

Which allows you to enter the virtual environment and continue with the instructions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the /coverage/ documentation, section 5.2.1.1, and compare the existing virtual-environment activation command with the Windows-specific command given in the issue. Update the instructions to mention the Windows activation step, then verify that the surrounding installation sequence remains clear for Windows readers.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.