classification
Title: venv.EnvBuilder docstring inconsistencies
Type: Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: bfroehle, docs@python, eric.araujo, python-dev, vinay.sajip
Priority: normal Keywords: easy

Created on 2012-11-01 04:10 by bfroehle, last changed 2012-11-14 11:19 by python-dev. This issue is now closed.

Messages (3)
msg174388 - (view) Author: Bradley Froehle (bfroehle) * Date: 2012-11-01 04:10
Consider the docstring for venv.EnvBuilder::

    By default, the builder makes the system (global) site-packages dir
    available to the created environment.

    By default, the creation process uses symlinks wherever possible.

It seems to suggest that the `system_site_packages` and `symlink` parameters both default to True, even though the default values for each are False.

The docstring for venv.create is similarly misleading.
msg174392 - (view) Author: √Čric Araujo (eric.araujo) * (Python committer) Date: 2012-11-01 06:39
Tagging for the bug day.
msg175562 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-11-14 11:19
New changeset afb476dc202f by Vinay Sajip in branch '3.3':
Issue #16378: Updated docstrings to reflect the defaults present in the code.
http://hg.python.org/cpython/rev/afb476dc202f

New changeset 6f0e49ed0589 by Vinay Sajip in branch 'default':
Closes #16378: Merged docstring changes from 3.3.
http://hg.python.org/cpython/rev/6f0e49ed0589
History
Date User Action Args
2012-11-14 11:19:58python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg175562

resolution: fixed
stage: resolved
2012-11-01 06:39:46eric.araujosetkeywords: + easy
nosy: + vinay.sajip, eric.araujo
messages: + msg174392

2012-11-01 04:10:24bfroehlecreate