DOC: reorganize and simplify contributing.rst#7699
Conversation
doc/devel/contributing.rst
Outdated
|
|
||
| python setup.py build | ||
| This installs Matplotlib in 'editable/develop mode', i.e., | ||
| builds everything and places symbolic links back to the source code |
There was a problem hiding this comment.
I don't think the symbolic link statement is true anymore. It adds a file in which the path to the library is written, and the path is explored at runtime.
(as I don't understand anything about the way python packaging is done, you should take this claim with a grain of salt…)
There was a problem hiding this comment.
I think you are right....
NelleV
changed the title
- only provide one installation direction - put details about local testing at the top
tacaswell
force-pushed
the
doc_clearify_installation
branch
from
c78c4db to
600544c
Compare
QuLogic
left a comment
QuLogic
left a comment
There was a problem hiding this comment.
A minor thing, but it appears you've capitalized all the other cases...
doc/devel/contributing.rst
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| If you already have a version of matplotlib installed, you will need to |
doc/devel/contributing.rst
Outdated
|
|
||
| git clone git@github.com:matplotlib/matplotlib.git | ||
|
|
||
| and navigate to the matplotlib directory. |
|
I only meant in the newly inserted lines, but that works too. 😛 |
|
It was easier to do a human-moderated matplotlib -> Matplotlib find and replace on the whole file than to sort out which lines I had previously touched. |
|
We need to make sure we are as consistent as possible on that capitalization issue. I'll do that on the whole documentation. |
doc/devel/contributing.rst
Outdated
| .. warning:: | ||
|
|
||
| If you already have a version of Matplotlib installed, you will need to | ||
| uninstall it. |
There was a problem hiding this comment.
Only in the same venv, I think? AFAICT that looks big and scary while it is simply not true if the instructions above are followed :-)
There was a problem hiding this comment.
You can drive your self to very strange situations with overlapping installs, but will re-word this to be a bit less scary.
dopplershift
left a comment
dopplershift
left a comment
There was a problem hiding this comment.
Just the one minor change.
doc/devel/contributing.rst
Outdated
|
|
||
| git clone git@github.com:matplotlib/matplotlib.git | ||
|
|
||
| and navigate to the Matplotlib directory. |
There was a problem hiding this comment.
Matplotlib -> matplotlib since you're talking about the directory.
doc/devel/contributing.rst
Outdated
| .. warning:: | ||
|
|
||
| If you already have a version of Matplotlib installed, use an | ||
| virtual environment or uninstalling using the same method you used |
QuLogic
changed the title
QuLogic
modified the milestones:
2.0 (style change major release),
2.0.1 (next bug fix release)
5 participants
attn @NelleV
attn @goldstarwebs