Skip to content

venv.EnvBuilder docstring inconsistencies #60582

Closed

Description

@bfroehle
mannequin
BPO 16378
Nosy @vsajip, @merwok

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2012-11-14.11:19:58.822>
created_at = <Date 2012-11-01.04:10:24.336>
labels = ['easy', 'docs']
title = 'venv.EnvBuilder docstring inconsistencies'
updated_at = <Date 2012-11-14.11:19:58.814>
user = 'https://bugs.python.org/bfroehle'

bugs.python.org fields:

activity = <Date 2012-11-14.11:19:58.814>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-11-14.11:19:58.822>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2012-11-01.04:10:24.336>
creator = 'bfroehle'
dependencies = []
files = []
hgrepos = []
issue_num = 16378
keywords = ['easy']
message_count = 3.0
messages = ['174388', '174392', '175562']
nosy_count = 5.0
nosy_names = ['vinay.sajip', 'eric.araujo', 'docs@python', 'python-dev', 'bfroehle']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue16378'
versions = ['Python 3.3', 'Python 3.4']

Activity

  1. bfroehle commented on Nov 1, 2012

    bfroehlemannequin
    MannequinAuthor

    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.

  2. merwok commented on Nov 1, 2012

    @merwok
    Member

    Tagging for the bug day.

  3. python-dev commented on Nov 14, 2012

    python-devmannequin
    Mannequin

    New changeset afb476dc202f by Vinay Sajip in branch '3.3':
    Issue bpo-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 bpo-16378: Merged docstring changes from 3.3.
    http://hg.python.org/cpython/rev/6f0e49ed0589

  4. transferred this issue fromon Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc direasy

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions