-
Notifications
You must be signed in to change notification settings - Fork 224
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
Rename tutorial.py to samples.py #1110
Conversation
As discussed in #1101 here's a PR to rename ``tutorial.py`` (in which functions are defined to load sample data from the GMT tutorials) to ``samples.py``.
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.
Please also update the docstrings. Currently, it still says
Functions to load sample data from the GMT tutorials.
Also, rename pygmt/tests/test_datasets_tutorial.py
to pygmt/tests/test_datasets_samples.py
.
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 think we can just merge this as is without waiting, so that the load fracture sample data PR at #1101 can move forward. @michaelgrund has been very patient with wrapping the Can you merge this PR in by yourself @michaelgrund once all the tests pass? Just need to click on the green 'Squash and Merge' button, and make sure to tidy up the commit message a bit (describe what was done in this PR and remove unnecessary lines like '* updated |
* Rename tutorial.py to samples.py Co-authored-by: Wei Ji <[email protected]>
Description of proposed changes
As discussed in #1101 here's a PR to rename
tutorial.py
(in which functions are defined to load sample data from the GMT tutorials) tosamples.py
.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