Skip to content

Commit 885ebc3

Browse files
committed
invert --user recommendation in CONTRIBUTING
make `--user` the non-default option, given the prevalence of conda/virtual envs these days
1 parent f57b92d commit 885ebc3

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

CONTRIBUTING.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,13 @@ Installing the Jupyter Notebook
4848
Once you have installed the dependencies mentioned above, use the following
4949
steps::
5050

51-
pip install setuptools pip --upgrade --user
51+
pip install --upgrade setuptools pip
5252
git clone https://github.com/jupyter/notebook
5353
cd notebook
54-
pip install -e . --user
54+
pip install -e .
5555

56-
If you want the development environment to be available for all users of your
57-
system (assuming you have the necessary rights) or if you are installing in a
58-
virtual environment, just drop the ``--user`` option.
56+
If you are using a system-wide Python installation and you only want to install the notebook for you,
57+
you can add ``--user`` to the install commands.
5958

6059
Once you have done this, you can launch the master branch of Jupyter notebook
6160
from any directory in your system with::
@@ -106,7 +105,7 @@ Python Tests
106105

107106
Install dependencies::
108107

109-
pip install -e .[test] --user
108+
pip install -e .[test]
110109

111110
To run the Python tests, use::
112111

@@ -155,10 +154,9 @@ containing all the necessary packages (except pandoc), use::
155154
.. _conda environment:
156155
http://conda.pydata.org/docs/using/envs.html#use-environment-from-file
157156

158-
If you want to install the necessary packages with ``pip`` instead, use
159-
(omitting --user if working in a virtual environment)::
157+
If you want to install the necessary packages with ``pip`` instead::
160158

161-
pip install -r docs/doc-requirements.txt --user
159+
pip install -r docs/doc-requirements.txt
162160

163161
Once you have installed the required packages, you can build the docs with::
164162

0 commit comments

Comments
 (0)