From 5b7373da5dc5bdc582d7cb1f28db761d388b5d19 Mon Sep 17 00:00:00 2001 From: Matthew Clapp Date: Thu, 10 Jun 2021 15:40:12 -0700 Subject: [PATCH 1/3] Update venv.ensure_directories() docs. --- Doc/library/venv.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 2a4eede91a7c17..78331827df9cf0 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -170,11 +170,11 @@ 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 is just a + holder for attributes (such as paths), for use by the other methods. + Any existing environment directories will remain unaffected as long as + ``clear`` was not specified. .. method:: create_configuration(context) From 174178350941f3c0d5fe445716539a11079a5e1e Mon Sep 17 00:00:00 2001 From: Matthew Clapp Date: Mon, 14 Jun 2021 20:59:25 -0700 Subject: [PATCH 2/3] Rephrase last sentence. --- Doc/library/venv.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 78331827df9cf0..5f2c72eda40698 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -173,8 +173,9 @@ creation according to their needs, the :class:`EnvBuilder` class. Creates the environment directory and all necessary subdirectories that don't already exist, and returns a context object. This is just a holder for attributes (such as paths), for use by the other methods. - Any existing environment directories will remain unaffected as long as - ``clear`` was not specified. + 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) From 5e66ecbf5f4c3bbc30cdec3b4b5c983aa06034c6 Mon Sep 17 00:00:00 2001 From: Matthew Clapp Date: Sat, 19 Jun 2021 18:47:13 -0700 Subject: [PATCH 3/3] Clarify "this" and remove superfluous comma. --- Doc/library/venv.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 5f2c72eda40698..5eb5094801501b 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -171,11 +171,11 @@ creation according to their needs, the :class:`EnvBuilder` class. .. method:: ensure_directories(env_dir) Creates the environment directory and all necessary subdirectories that - don't already exist, and returns a context object. This 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. + 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)