The understatement in the documentation of the `venv` module about the method `_setup_pip`

Open
#99,690 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the venv module API documentation linked in the issue and inspect the relationship between create, with_pip, and _setup_pip. Clarify whether _setup_pip should become public, then document the decided API and its role in creating pip when with_pip is true.

Written by the indexing model from the issue text.

Description

docs stdlib topic-venv

The understatement in the documentation of the venv module about the method _setup_pip

We are talking about documentation . There is not a single line about the _setup_pip method in it.

However, this is an important method for creating pip in a virtual environment. The _setup_pip method is call only in the create method, only if self.with_pip=True. Can the _setup_pip method be made public and added to the documentation?

Dominant language
Python
Stars
77.2k
Forks
36k
Avg merge
1d 9h
Merged PRs (30d)
558

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.

More from python/cpython

All issues in python/cpython

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.