summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Doc/library/venv.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 2a4eede..5eb5094 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)