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

pygmt.grdfill: Add alias "no_data" for "N" #2618

Merged
merged 4 commits into from Aug 1, 2023
Merged

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jul 30, 2023

Description of proposed changes

This PR aims to add the alias no_data for N of pygmt.grdfill. Following the Code Style (please see https://www.pygmt.org/dev/contributing.html#code-style) an underscore is used, despite the Julia documentation uses nodata (please see https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/grdfill/index.html#grdfill).

Upstream GMT documentation: https://docs.generic-mapping-tools.org/dev/grdfill.html#n

Preview: https://pygmt-dev--2618.org.readthedocs.build/en/2618/api/generated/pygmt.grdfill.html

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

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation enhancement Improving an existing feature labels Jul 30, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone Jul 30, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Jul 30, 2023
@yvonnefroehlich yvonnefroehlich removed the documentation Improvements or additions to documentation label Jul 30, 2023
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jul 31, 2023
@seisman seisman merged commit fba1bc7 into main Aug 1, 2023
16 checks passed
@seisman seisman deleted the add-alias-grdfill-N branch August 1, 2023 04:03
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improving an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants