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.

Sign up for GitHub

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

Jump to bottom

Add inline example for grdclip #1711

Merged
merged 2 commits into from
Feb 2, 2022
Merged

Add inline example for grdclip #1711

merged 2 commits into from
Feb 2, 2022

Conversation

willschlitzer
Copy link
Contributor

This PR adds an inline example for grdclip.

Addresses: #1686

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 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 28, 2022
@willschlitzer willschlitzer added this to the 0.6.0 milestone Jan 28, 2022
@willschlitzer willschlitzer self-assigned this Jan 28, 2022
@willschlitzer willschlitzer mentioned this pull request Jan 28, 2022
Open
25 tasks
@willschlitzer willschlitzer changed the title Add inline example for grdcut Add inline example for grdclip Jan 28, 2022
maxrjones
maxrjones reviewed Jan 28, 2022
View reviewed changes
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.

What do you think about adding a couple lines to report the range of data values (suggestions below)? This might help people understand the impact on the data and would be essential if we ever want to include these in the tests.

pygmt/src/grdclip.py Show resolved Hide resolved
pygmt/src/grdclip.py Show resolved Hide resolved
@willschlitzer
Copy link
Contributor Author

What do you think about adding a couple lines to report the range of data values (suggestions below)? This might help people understand the impact on the data and would be essential if we ever want to include these in the tests.

I'm not a big fan of using pseudo-print statements to show the effect of the grdclip. Should we make it more like the GMT example and have more explanation in the text?

@maxrjones
Copy link
Member

What do you think about adding a couple lines to report the range of data values (suggestions below)? This might help people understand the impact on the data and would be essential if we ever want to include these in the tests.

I'm not a big fan of using pseudo-print statements to show the effect of the grdclip. Should we make it more like the GMT example and have more explanation in the text?

I think this way of displaying the output to show and test results in docstring examples is really common for scientific Python libraries e.g., geopandas.DataFrame.clip - docstring source and pandas.DataFrame.clip - dostring source.

@seisman
Copy link
Member

seisman commented Jan 30, 2022

I agree with @meghanrjones

@willschlitzer
Copy link
Contributor Author

@seisman @meghanrjones Sounds good!

@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Feb 1, 2022
maxrjones
maxrjones approved these changes Feb 1, 2022
View reviewed changes
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.

Great, thanks!

@weiji14 weiji14 merged commit 2445b9e into main Feb 2, 2022
@weiji14 weiji14 deleted the inline-example/grdclip branch February 2, 2022 14:00
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Feb 2, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@willschlitzer @maxrjones
Add inline example for grdclip (GenericMappingTools#1711)
5a7f6b6 
Example to create a new grid from an input grid using
pygmt.grdclip. Shows how users can set values that
are above/below a given value to a new value.

Co-authored-by: Meghan Jones <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiji14 weiji14 weiji14 approved these changes

@maxrjones maxrjones maxrjones approved these changes

Assignees

@willschlitzer willschlitzer

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.
4 participants
@willschlitzer @maxrjones @seisman @weiji14