summaryrefslogtreecommitdiff
path: root/docs/narr/install.rst
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2017-06-18 01:46:27 -0500
committerMichael Merickel <michael@merickel.org>2017-06-18 01:46:27 -0500
commit75c30dfe18b26ca04efae2acbe35052fa0d93ed6 (patch)
treeebb57879035b60a801cd4deb113c4091956b67be /docs/narr/install.rst
parent4983421128e2e0fc92c771510f7b3af57de6d855 (diff)
parent5c437abba0926f6093efbd481e49763de2436665 (diff)
downloadpyramid-75c30dfe18b26ca04efae2acbe35052fa0d93ed6.tar.gz
pyramid-75c30dfe18b26ca04efae2acbe35052fa0d93ed6.tar.bz2
pyramid-75c30dfe18b26ca04efae2acbe35052fa0d93ed6.zip
Merge branch 'master' into pr/3034
Diffstat (limited to 'docs/narr/install.rst')
-rw-r--r--docs/narr/install.rst4
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.