Skip to content
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

Revise the notes about registration and gtype of remote datasets #2384

Merged
merged 12 commits into from
Mar 22, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 26, 2023

Description of proposed changes

See #2378 for context.

Preview: https://pygmt-dev--2384.org.readthedocs.build/en/2384/api/generated/pygmt.datasets.load_earth_age.html

Fixes #2378

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@seisman seisman added the needs review This PR has higher priority and needs review. label Feb 26, 2023
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
pygmt/datasets/earth_age.py Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

@yvonnefroehlich and @michaelgrund, if the wording looks ok, can @seisman apply the changes to the other datasets/earth_*.py files?

pygmt/datasets/earth_age.py Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman added this to the 0.9.0 milestone Mar 17, 2023
@seisman seisman added the documentation Improvements or additions to documentation label Mar 17, 2023
seisman and others added 3 commits March 18, 2023 10:05
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman marked this pull request as ready for review March 19, 2023 04:42
@seisman
Copy link
Member Author

seisman commented Mar 21, 2023

@michaelgrund and @yvonnefroehlich Any comments on this PR? Or can it be approved?

@seisman seisman merged commit df7b7cd into main Mar 22, 2023
@seisman seisman deleted the datasets-notes branch March 22, 2023 00:36
@seisman seisman removed the needs review This PR has higher priority and needs review. label Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the notes that high-resolution remote datasets don't support slice operations
4 participants