From 4bcef2bb48b3fd82011a89c1c716421b789f1442 Mon Sep 17 00:00:00 2001 From: Matthew Clapp Date: Fri, 2 Jul 2021 13:48:15 -0700 Subject: [PATCH] bpo-44388: Update venv EnvBuilder.ensure_directories() docs. (GH-26663) Ref: This changes the documentation for `EnvBuilder.ensure_directories(env_dir)` to match the actual behavior of that API call. In particular, `ensure_directories()` is not affected by the state of the `upgrade` attribute, and will not cause an error to have existing directories whether or not the `clear` attribute is set. This documentation change I believe should be valid to all python versions back to 3.6. Automerge-Triggered-By: GH:vsajip --- Doc/library/venv.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 2a4eede91a7..5eb50948015 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -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)