Skip to content

bpo-44388: Update venv EnvBuilder.ensure_directories() docs. #26663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2021
Merged

bpo-44388: Update venv EnvBuilder.ensure_directories() docs. #26663

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b7373d
Update venv.ensure_directories() docs.
itsayellow Jun 10, 2021
1741783
Rephrase last sentence.
itsayellow Jun 15, 2021
5e66ecb
Clarify "this" and remove superfluous comma.
itsayellow Jun 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions Doc/library/venv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,12 @@ creation according to their needs, the :class:`EnvBuilder` class.

.. method:: ensure_directories(env_dir)

Creates the environment directory and all necessary directories, and
returns a context object. This is just a holder for attributes (such as
paths), for use by the other methods. The directories are allowed to
exist already, as long as either ``clear`` or ``upgrade`` were
specified to allow operating on an existing environment directory.
Creates the environment directory and all necessary subdirectories that
don't already exist, and returns a context object. This context object
is just a holder for attributes (such as paths) for use by the other
methods. If the :class:`EnvBuilder` is created with the arg
``clear=True``, contents of the environment directory will be cleared
and then all necessary subdirectories will be recreated.

.. method:: create_configuration(context)

Expand Down