Michael Merickel
2017-06-07 57ce7b0c251d34e29a2eb5375c70e751c9b83f4e
explain why we prefer to avoid activate

fixes #3064
1 files modified
4 ■■■ changed files
docs/narr/install.rst 4 ●●● patch | view | raw | blame | history
docs/narr/install.rst
@@ -206,9 +206,7 @@
   ``$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.