diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-06-28 19:36:09 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-28 19:36:09 (GMT) |
commit | 0cba121029bae0a891b02c493cb77633620701be (patch) | |
tree | 246a2bd6435bcc07c251be9f493a601b583d5fe2 /Doc/tutorial/venv.rst | |
parent | e3761ca91cda86462206d60244078f05c636dd13 (diff) | |
download | cpython-0cba121029bae0a891b02c493cb77633620701be.zip cpython-0cba121029bae0a891b02c493cb77633620701be.tar.gz cpython-0cba121029bae0a891b02c493cb77633620701be.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.
(cherry picked from commit f9f8e3ce709ceb15c8db8c8dde940daf1febf13d)
Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>
Diffstat (limited to 'Doc/tutorial/venv.rst')
-rw-r--r-- | Doc/tutorial/venv.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/tutorial/venv.rst b/Doc/tutorial/venv.rst index dc4136e..558076d 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:: |