Collect information for setting up a development environment #19215
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
story645
requested changes
Jan 5, 2021
doc/devel/development_setup.rst
Outdated
| You should set up a dedicated `virtual environment`_ to decouple your | ||
| Matplotlib development from other Python and Matplotlib installations on your | ||
| system. This is the environment you can safely develop and test your changes | ||
| in. |
There was a problem hiding this comment.
maybe add a sentence like "Here we recommend the venv virtual environment, you may use others such as conda." (especially since you wrote the env file!)
There was a problem hiding this comment.
Yes. More on that will come with #17096.
7bcae21 to
1fec2ae
Compare
story645
approved these changes
Jan 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
It is reasonable to have all development setup information together in one place. You usually only install once, but possibly you want to directly install everything needed to run tests and build documentation as well. Thus, I find it better to list all dependencies here and only link from the documenting and testing sections (The links have been there anyway because they back-reference the general part of setting up a development environement.
This mainly rearranges existing descriptions and adapts wording a little. For sure, there could be done more (e.g. mentioning the docker image or describing how to do this in a conda environment #17096), but I'd leave these for another time because the rearrangement here is large enough already for reviewers.
Also related to #17327.