Redesign check_figures_equal testing function to be more explicit #590
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.
Description of proposed changes
Improve readability of test code by explicitly declaring
fig_ref
andfig_test
aspygmt.Figure
objects, and returning the two figures to be compared against. Makes each testing code more standalone, though it will become 3 lines longer.Before
After
This PR is a small redesign of #555, and works towards #579 (vendoring the
@check_figure_equal
decorator topytest-mpl
.Fixes #
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.