Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6137a38

Browse files
pambottacaswell
andcommitted
apply docs wording suggestions
Co-Authored-By: Thomas A Caswell <[email protected]>
1 parent 19f7f4b commit 6137a38

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

INSTALL.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -99,27 +99,29 @@ and run: ::
9999

100100
git clone https://github.com/matplotlib/matplotlib.git
101101

102-
Matplotlib can be installed from the source directory with a simple ::
103-
104-
pip install .
105-
106102
If you're developing, it's better to do it in editable mode. The reason why
107-
is that there's a few artifacts for testing that are only properly referenced
103+
is that pytest's test discovery only works for Matplotlib
108104
if installation is done this way. Also, editable mode allows your code changes
109-
to be instantly propagated to your library code without rebuilding (though
110-
you will have to restart your kernel): ::
105+
to be instantly propagated to your library code without reinstalling (though
106+
you will have to restart your python process / kernel): ::
111107

112108
pip install -e .
113109

114-
Additionally, if you are planning on contributing, you may need additional
115-
dev dependencies: ::
110+
If you're not developing, it can be installed from the source directory with
111+
a simple ::
112+
113+
pip install .
114+
115+
To run the tests you will need to install some additional dependencies: ::
116116

117117
pip install -r requirements/dev/dev.txt
118118

119-
**Warning:** The following instructions in this section are for very custom
120-
installations of Matplotlib. Proceed with caution because these instructions
121-
may result in your build producing unexpected behavior and/or causing
122-
local testing to fail.
119+
.. warning ::
120+
121+
The following instructions in this section are for very custom
122+
installations of Matplotlib. Proceed with caution because these instructions
123+
may result in your build producing unexpected behavior and/or causing
124+
local testing to fail.
123125
124126
If you would like to build from a tarball, grab the latest *tar.gz* release
125127
file from `the PyPI files page <https://pypi.org/project/matplotlib/>`_.

0 commit comments

Comments
 (0)