summaryrefslogtreecommitdiffstats
path: root/Doc/library/venv.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2020-01-14 20:49:30 (GMT)
committerGitHub <noreply@github.com>2020-01-14 20:49:30 (GMT)
commit7d6378051feeadf45b4ce45b4b406b65df255648 (patch)
tree1046f35a3335e2ad083d1d5bdcc277035a2ddc23 /Doc/library/venv.rst
parent4b0d91aab4cfba30a2a9728e9eaea15dbc0ba9bd (diff)
downloadcpython-7d6378051feeadf45b4ce45b4b406b65df255648.zip
cpython-7d6378051feeadf45b4ce45b4b406b65df255648.tar.gz
cpython-7d6378051feeadf45b4ce45b4b406b65df255648.tar.bz2
bpo-38901: Allow setting a venv's prompt to the basename of the current directory. (GH-17946)
When a prompt value of '.' is specified, os.path.basename(os.getcwd()) is used to configure the prompt for the created venv.
Diffstat (limited to 'Doc/library/venv.rst')
-rw-r--r--Doc/library/venv.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 5494c0c..d778486 100644
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -122,7 +122,8 @@ creation according to their needs, the :class:`EnvBuilder` class.
* ``prompt`` -- a String to be used after virtual environment is activated
(defaults to ``None`` which means directory name of the environment would
- be used).
+ be used). If the special string ``"."`` is provided, the basename of the
+ current directory is used as the prompt.
* ``upgrade_deps`` -- Update the base venv modules to the latest on PyPI