-
Notifications
You must be signed in to change notification settings - Fork 220
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the check_figures_equal testing section in CONTRIBUTING.md #1108
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @willschlitzer! Just one minor suggestion.
Co-authored-by: Wei Ji <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with the changes, but let's leave it up for another 24 hours in case someone has an opinion on something.
Co-authored-by: Meghan Jones <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
…nericMappingTools#1108) Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Meghan Jones <[email protected]>
This PR moves the
check_figures_equal
notes from the top of the testing section to below thempl_image_compare
anddvc
sections. It removes the note saying thatcheck_figures_equal
is the preferred method of testing as it avoids committing images to the repository. It adds that usingmpl_image_compare
is the preferred way of testing.Fixes #
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version