Describe how to test regular installations of Matplotlib #19350
Merged
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 24, 2021
f7f578c to
4061b6c
Compare
story645
requested changes
Jan 25, 2021
doc/devel/testing.rst
Outdated
| Obtain the reference images | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| Many tests compare the plot result against reference images. The reference | ||
| images are not part of the regular packaged versions (wheels or conda |
There was a problem hiding this comment.
Suggested change
| images are not part of the regular packaged versions (wheels or conda | |
| images are not part of the regular packaged versions (pip wheels or conda |
|
I agree with moving this. OTOH, is this needed at all? Do people actually need to do this? |
4061b6c to
9007556
Compare
As I explicitly write in the note, the average end-user does not need it. However, there may be more elaborate cases. For example, a packager might want to check that a generated distribution artifact works correctly. In that case, you'd want to install your artifact and run the tests on that. So I think it's reasonable that we provide the info on testing installs. |
story645
approved these changes
Jan 25, 2021
|
merged - I was just making sure you really thought this was necessary because our docs already go off on some tangents.. |
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
This replaces the "Test data" section in installation. Because testing an installation is rarely needed, I've also moved this to the "Testing" docs. IMHO a regular user wanting to install Matplotlib should not be bothered in any way with rather distracting testing information.