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

Expand grdfill's aliases to include coltypes (f) #1371

Open
weiji14 opened this issue Jul 6, 2021 · 0 comments
Open

Expand grdfill's aliases to include coltypes (f) #1371

weiji14 opened this issue Jul 6, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Helping hands are appreciated

Comments

@weiji14
Copy link
Member

weiji14 commented Jul 6, 2021

Description of the desired feature

Continuing on from #1276, there are some parameters in upstream GMT at https://docs.generic-mapping-tools.org/6.2/grdfill.html which are still missing in PyGMT at https://www.pygmt.org/v0.4.0/api/generated/pygmt.grdfill.html. Your task is to fill them in!

Current state 📝

R="region",
V="verbose",

{R}
{V}

Desired state ✨

You'll need to change two parts of the grdfill.py module like so:

    R="region", 
    V="verbose", 
    f="coltypes",
    {R}
    {V}
    {f}

How to make the change 🧐

  1. First, read up our contributing guidelines at https://www.pygmt.org/v0.4.0/contributing.html#editing-the-documentation
  2. Leave a comment below, stating that you will tackle this issue. We will assign you to this issue and you can then start working on it.
  3. To edit the grdfill module's docstring, go to https://github.com/GenericMappingTools/pygmt/edit/master/pygmt/src/grdfill.py and add in the new docstring!
  4. Submit a pull request, and be sure to fill it up with as much detail as possible.

Tip: See the Pull Request at #1343 for an example of how a common alias can be added.

Stretch goals 🚀

Suggest a good long alias name for the grdfill -N parameter, and add it to the Pull Request!

🥳 Good luck, and let us know if you need any help :)

Are you willing to help implement and maintain this feature? Happy to review someone's Pull Request on it.

@weiji14 weiji14 added documentation Improvements or additions to documentation scipy-sprint Things to work on during the SciPy sprint! labels Jul 6, 2021
@weiji14 weiji14 added the good first issue Good for newcomers label Jul 6, 2021
@maxrjones maxrjones added eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop and removed scipy-sprint Things to work on during the SciPy sprint! labels Aug 1, 2021
@maxrjones maxrjones added the help wanted Helping hands are appreciated label Aug 19, 2021
@weiji14 weiji14 removed the eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop label Sep 21, 2021
@seisman seisman added this to the 0.7.0 milestone Mar 16, 2022
@seisman seisman modified the milestones: 0.7.0, 0.8.0 Jun 23, 2022
@seisman seisman modified the milestones: 0.8.0, 0.9.0 Dec 11, 2022
@weiji14 weiji14 removed this from the 0.9.0 milestone Mar 6, 2023
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 good first issue Good for newcomers help wanted Helping hands are appreciated
Projects
None yet
Development

No branches or pull requests

3 participants