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

Add inline example for grd2xyz #1713

Merged
merged 10 commits into from
Feb 10, 2022
Merged

Add inline example for grd2xyz #1713

merged 10 commits into from
Feb 10, 2022

Conversation

willschlitzer
Copy link
Contributor

This PR adds an inline example for grd2xyz.

Addresses: #1686

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.

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

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Jan 29, 2022
@willschlitzer willschlitzer added this to the 0.6.0 milestone Jan 29, 2022
@willschlitzer willschlitzer self-assigned this Jan 29, 2022
pygmt/src/grd2xyz.py Outdated Show resolved Hide resolved
pygmt/src/grd2xyz.py Outdated Show resolved Hide resolved
pygmt/src/grd2xyz.py Show resolved Hide resolved
@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Feb 2, 2022
@willschlitzer
Copy link
Contributor Author

I changed "Examples" to "Example" in grdclip, grdcut, and grdfilter as there is only one inline example for each module.

Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Thanks, looks good after either applying the suggestion below or @seisman's +ELLIPSES suggestion.

pygmt/src/grd2xyz.py Outdated Show resolved Hide resolved
Co-authored-by: Meghan Jones <[email protected]>
Copy link
Member

@michaelgrund michaelgrund 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!

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 10, 2022
@seisman seisman merged commit 2c04717 into main Feb 10, 2022
@seisman seisman deleted the inline-example/grd2xyz branch February 10, 2022 09:55
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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.

5 participants