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.xyz2grd #1506

Merged
merged 23 commits into from
Oct 28, 2021
Merged

Add missing aliases to pygmt.xyz2grd #1506

merged 23 commits into from
Oct 28, 2021

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Sep 13, 2021

This pull request adds missing aliases for xyz2grd.

Continuation of #635 and #636. Addresses #1424.

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

@willschlitzer willschlitzer added the enhancement Improving an existing feature label Sep 13, 2021
@willschlitzer willschlitzer added this to the 0.5.0 milestone Sep 13, 2021
@willschlitzer willschlitzer self-assigned this Sep 13, 2021
@willschlitzer willschlitzer changed the title WIP: Add missing aliases to xyz2grd Add missing aliases to xyz2grd Sep 15, 2021
@willschlitzer willschlitzer marked this pull request as ready for review September 15, 2021 21:27
@maxrjones
Copy link
Member

Please change:

    Full option list at :gmt-docs:`xyz2grd.html`

    Parameters

to

    Full option list at :gmt-docs:`xyz2grd.html`

    {aliases}

    Parameters

@weiji14 weiji14 added documentation Improvements or additions to documentation and removed enhancement Improving an existing feature labels Sep 17, 2021
@willschlitzer
Copy link
Contributor Author

Please change:

    Full option list at :gmt-docs:`xyz2grd.html`

    Parameters

to

    Full option list at :gmt-docs:`xyz2grd.html`

    {aliases}

    Parameters

changed

pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
@willschlitzer willschlitzer added the skip-changelog Skip adding Pull Request to changelog label Sep 23, 2021
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
@maxrjones
Copy link
Member

I think xyz2grd should go under "operations on tabular data" rather than "operations on grids" in doc/api/index.rst.

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

I think xyz2grd should go under "operations on tabular data" rather than "operations on grids" in doc/api/index.rst.

changed in fda29eb

pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
@willschlitzer willschlitzer requested a review from a team October 25, 2021 09:50
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
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.

Looks good! Just three suggestions - two for adding missing lower-case common options and one for referring to an alias rather than short option.

pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Show resolved Hide resolved
pygmt/src/xyz2grd.py Show resolved Hide resolved
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me!

@willschlitzer
Copy link
Contributor Author

When I run make check it gives me a bunch of errors for invalid escape sequences; is there anyway to disable this for the style checks?

pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
Co-authored-by: Meghan Jones <[email protected]>
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One suggestion to add alias for projection -J, but still missing aliases for -D/-S/-Z from https://docs.generic-mapping-tools.org/6.2/xyz2grd. If you're not adding those 3 (which is fine if you're in a rush to get this merged before v0.5.0), then please edit the first post to change "Fixes #1424" to "Addresses #1424".

pygmt/src/xyz2grd.py Show resolved Hide resolved
pygmt/src/xyz2grd.py Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
pygmt/src/xyz2grd.py Outdated Show resolved Hide resolved
@weiji14 weiji14 changed the title Add missing aliases to xyz2grd Add missing aliases to pygmt.xyz2grd Oct 28, 2021
@weiji14 weiji14 merged commit d12470f into main Oct 28, 2021
@weiji14 weiji14 deleted the add-params-xyz2grd branch October 28, 2021 22:57
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Add missing aliases duplicate (A), projection (J), convention (Z),
binary (b), nodata (d), find (e), coltypes (f), header (h), incols (i),
registration (r), and wrap (w) to pygmt.xyz2grd.

Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Wei Ji <[email protected]>
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 skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants