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 missing aliases to pygmt.surface #1501

Merged
merged 4 commits into from
Sep 13, 2021
Merged

Add missing aliases to pygmt.surface #1501

merged 4 commits into from
Sep 13, 2021

Conversation

michaelgrund
Copy link
Member

Description of proposed changes

This PR adds the common options binary, nodata, find, header, incols and skiprows to the pygmt.surface method.

Addresses #1445

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 michaelgrund added the documentation Improvements or additions to documentation label Sep 12, 2021
@michaelgrund michaelgrund added this to the 0.5.0 milestone Sep 12, 2021
Copy link
Contributor

@willschlitzer willschlitzer 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! All added aliases match up with the corresponding name in the docs.

@willschlitzer willschlitzer added the final review call This PR requires final review and approval from a second reviewer label Sep 13, 2021
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.

Another common option that was missing from the issue based on gmt docs and THIS_MODULE_OPTIONS macro.

pygmt/src/surface.py Show resolved Hide resolved
pygmt/src/surface.py Show resolved Hide resolved
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 13, 2021
@seisman seisman merged commit 71dd530 into main Sep 13, 2021
@seisman seisman deleted the add-comm-ops-surface branch September 13, 2021 23:49
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
This pull request was closed.
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.

4 participants