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 alias 'registration' to methods blockmean, info, grdfilter, surface #1089

Merged
merged 3 commits into from
Mar 21, 2021

Conversation

maxrjones
Copy link
Member

Description of proposed changes

This PR fixes the format of the registration alias in pygmt/helpers/decorators.py and adds the alias to the wrapped modules that support the -r common option. It also revises the description for the -r option slightly, since some modules that support -r do not involve output grids.

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

@seisman
Copy link
Member

seisman commented Mar 21, 2021

Looks good. Perhaps change the PR title to "Add alias 'registration' to methods blockmean, info, grdfilter, surface".

@seisman seisman added this to the 0.4.0 milestone Mar 21, 2021
@seisman seisman added the enhancement Improving an existing feature label Mar 21, 2021
@maxrjones maxrjones changed the title Fix format of registration alias Add alias 'registration' to methods blockmean, info, grdfilter, surface Mar 21, 2021
@maxrjones maxrjones merged commit 7b333f8 into master Mar 21, 2021
@maxrjones maxrjones deleted the r-alias branch March 21, 2021 13:54
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
enhancement Improving an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants