Skip to content

Rename tutorial.py to samples.py#1110

Merged
michaelgrund merged 4 commits intomasterfrom
rename-tutorial-to-samples
Mar 23, 2021
Merged

Rename tutorial.py to samples.py#1110
michaelgrund merged 4 commits intomasterfrom
rename-tutorial-to-samples

Conversation

@michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Mar 23, 2021

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) to samples.py.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@michaelgrund
Rename tutorial.py to samples.py
01b9d0e 
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``.
@michaelgrund michaelgrund added the maintenance Boring but important stuff for the core devs label Mar 23, 2021
@michaelgrund michaelgrund requested review from seisman and weiji14 March 23, 2021 08:21
@michaelgrund michaelgrund added this to the 0.4.0 milestone Mar 23, 2021
@michaelgrund michaelgrund mentioned this pull request Mar 23, 2021
Merged
5 tasks
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label Mar 23, 2021
seisman
seisman requested changes Mar 23, 2021
View reviewed changes
Copy link
Member

@seisman seisman left a 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.

@michaelgrund
Copy link
Member Author

michaelgrund commented Mar 23, 2021

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.

Done in a750769 @seisman!

seisman
seisman approved these changes Mar 23, 2021
View reviewed changes
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Changes in this PR will conflict with your PR #794. Do you want to merge this PR first, and solve the conflicts in PR #794, or the other way around?

@michaelgrund
Copy link
Member Author

michaelgrund commented Mar 23, 2021

Looks good.

Changes in this PR will conflict with your PR #794. Do you want to merge this PR first, and solve the conflicts in PR #794, or the other way around?

Yes, noticed that, will solve the conflict in #794 @seisman .

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 23, 2021
@weiji14
Copy link
Member

weiji14 commented Mar 23, 2021 •
edited
Loading

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 rose function and there's been a lot of sidetracks 🙂

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 __init__.py').

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 23, 2021
@maxrjones maxrjones mentioned this pull request Mar 23, 2021
Open
@michaelgrund michaelgrund merged commit 1b42aa4 into master Mar 23, 2021
@michaelgrund michaelgrund deleted the rename-tutorial-to-samples branch March 23, 2021 21:22
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@michaelgrund @weiji14
Rename tutorial.py to samples.py (GenericMappingTools#1110)
c7c497e 
* Rename tutorial.py to samples.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seisman seisman seisman approved these changes

@maxrjones maxrjones maxrjones approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.4.0

Development

Successfully merging this pull request may close these issues.

4 participants

@michaelgrund @weiji14 @seisman @maxrjones