diff options
| author | Michael Merickel <michael@merickel.org> | 2017-06-07 00:02:15 -0500 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2017-06-07 00:02:15 -0500 |
| commit | 57ce7b0c251d34e29a2eb5375c70e751c9b83f4e (patch) | |
| tree | 73b016876550d3df5ab8d517740f1436aeba889d /docs | |
| parent | c4f00ba7a78a6d0be4538f3fce3bf01f11dcf4e8 (diff) | |
| download | pyramid-57ce7b0c251d34e29a2eb5375c70e751c9b83f4e.tar.gz pyramid-57ce7b0c251d34e29a2eb5375c70e751c9b83f4e.tar.bz2 pyramid-57ce7b0c251d34e29a2eb5375c70e751c9b83f4e.zip | |
explain why we prefer to avoid activate
fixes #3064
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/narr/install.rst | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 2a25ad84d..c2bd00bff 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -206,9 +206,7 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or ``$VENV/bin/pip`` clearly specifies that ``pip`` is run from within the virtual environment and not at the system level. - ``activate`` drops turds into the user's shell environment, leaving them - vulnerable to executing commands in the wrong context. ``deactivate`` might - not correctly restore previous shell environment variables. + ``activate`` makes changes to the user's shell environment which can often be convenient. However, in the context of long-form documentation, environment configuration can easily be forgotten. By keeping each snippet explicit we can reduce copy / paste errors by users in which commands are executed against the wrong Python environment. Also, ``deactivate`` might not correctly restore previous shell environment variables. Avoiding ``activate`` keeps the environment more reproducible. Although using ``source bin/activate``, then ``pip``, requires fewer key strokes to issue commands once invoked, there are other things to consider. |
