diff options
| author | Pradyun Gedam <pradyunsg@gmail.com> | 2020-02-05 16:26:50 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-05 10:56:50 +0000 |
| commit | c281e04e04af376db7605dba1dcf20d2ab18c915 (patch) | |
| tree | 493eab158fccf0cd7026857e07c08cec7f0229e9 /docs/user_guide.rst | |
| parent | 8be186a1155dc353f872b9cd227ab0edf58978b9 (diff) | |
| download | virtualenv-rewrite.tar.gz | |
Minor updates to the documentation (#1540)rewrite
Diffstat (limited to 'docs/user_guide.rst')
| -rw-r--r-- | docs/user_guide.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 8fdb05b..ae72b36 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -10,7 +10,7 @@ Virtualenv has one basic command: virtualenv -this will create a python virtual environment of the same version as virtualenv is installed into under path +This will create a python virtual environment of the same version as virtualenv is installed into under path ``venv``. The path where to generate the virtual environment can be changed via a positional argument being passed in, see the :option:`dest` flag. The command line tool has quite a few of flags that modify the components behaviour, for a full list make sure to check out :ref:`cli_flags`. @@ -42,10 +42,10 @@ python ``3.8``, virtualenv will by default create virtual environments that are Created python virtual environments are usually not self-contained. A complete python packaging is usually made up of thousand of files, so it's not efficient to install the entire python again into a new folder. Instead virtual -environments are mere shells, that contain very little within itself, and borrow most from the system python (this is -what you installed, when you installed python itself). This does mean that if you upgrade your system python your -virtual environments *might* break, so watch out. The upside of this referring to the system python is that creating -virtual environments can be very fast. +environments are mere shells, that contain little within itself, and borrow most from the system python (this is what +you installed, when you installed python itself). This does mean that if you upgrade your system python your virtual +environments *might* break, so watch out. The upside of this referring to the system python is that creating virtual +environments can be fast. Here we'll describe the builtin mechanism (note this can be extended though by plugins). The CLI flag :option:`p` or :option:`python` allows you to specify a python specifier for what type of virtual environment you would like, the |