summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2017-06-10 12:50:20 -0700
committerSteve Piercy <web@stevepiercy.com>2017-06-10 12:50:20 -0700
commit8cbd2355d45fa6b1d6495564d0c12f646b860803 (patch)
tree80d9cbd2612597b454e13a64eb8a6f8e1641ef92 /docs/narr
parentd07c3a0e91a6f9d96e80c36e40470a83383a656c (diff)
parenta503511cf82ab1db8c66eb949eeb30da92dd621f (diff)
downloadpyramid-8cbd2355d45fa6b1d6495564d0c12f646b860803.tar.gz
pyramid-8cbd2355d45fa6b1d6495564d0c12f646b860803.tar.bz2
pyramid-8cbd2355d45fa6b1d6495564d0c12f646b860803.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'docs/narr')
-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.