summaryrefslogtreecommitdiffstats
path: root/Doc/tutorial
diff options
context:
space:
mode:
authorBrett Cannon <54418+brettcannon@users.noreply.github.com>2019-06-28 19:14:31 (GMT)
committerGitHub <noreply@github.com>2019-06-28 19:14:31 (GMT)
commitf9f8e3ce709ceb15c8db8c8dde940daf1febf13d (patch)
tree10868ca4f4d0abcbaf9ed58fe8f5216d55886911 /Doc/tutorial
parent242c26f53edb965e9808dd918089e664c0223407 (diff)
downloadcpython-f9f8e3ce709ceb15c8db8c8dde940daf1febf13d.zip
cpython-f9f8e3ce709ceb15c8db8c8dde940daf1febf13d.tar.gz
cpython-f9f8e3ce709ceb15c8db8c8dde940daf1febf13d.tar.bz2
bpo-37403: Touch up venv docs (GH-14458)
Add a versionadded for PS Core and note that `.venv` is a common virtual environment name.
Diffstat (limited to 'Doc/tutorial')
-rw-r--r--Doc/tutorial/venv.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/tutorial/venv.rst b/Doc/tutorial/venv.rst
index d8bb2f5..f422146 100644
--- a/Doc/tutorial/venv.rst
+++ b/Doc/tutorial/venv.rst
@@ -50,6 +50,12 @@ This will create the ``tutorial-env`` directory if it doesn't exist,
and also create directories inside it containing a copy of the Python
interpreter, the standard library, and various supporting files.
+A common directory location for a virtual environment is ``.venv``.
+This name keeps the directory typically hidden in your shell and thus
+out of the way while giving it a name that explains why the directory
+exists. It also prevents clashing with ``.env`` environment variable
+definition files that some tooling supports.
+
Once you've created a virtual environment, you may activate it.
On Windows, run::