Skip to content

Add missing aliases to pygmt.xyz2grd - #1506

Merged
weiji14 merged 23 commits into
mainfrom
add-params-xyz2grd
Oct 28, 2021
Merged

Add missing aliases to pygmt.xyz2grd#1506
weiji14 merged 23 commits into
mainfrom
add-params-xyz2grd

Conversation

@willschlitzer

@willschlitzerwillschlitzer commented Sep 13, 2021

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Member

Please change:

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

to

 Full option list at :gmt-docs:`xyz2grd.html`
{aliases}
Parameters

@weiji14weiji14 added documentation Improvements or additions to documentation and removed enhancement Improving an existing feature labels Sep 17, 2021
@willschlitzer

Copy link
Copy Markdown
ContributorAuthor

Please change:

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

to

 Full option list at :gmt-docs:`xyz2grd.html`
{aliases}
Parameters

changed

Comment threadpygmt/src/xyz2grd.py Outdated
@willschlitzerwillschlitzer added the skip-changelog Skip adding Pull Request to changelog label Sep 23, 2021
Comment threadpygmt/src/xyz2grd.py Outdated
@maxrjones

Copy link
Copy Markdown
Member

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

Comment threadpygmt/src/xyz2grd.py Outdated
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@willschlitzer

Copy link
Copy Markdown
ContributorAuthor

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

changed in fda29eb

Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py
Comment threadpygmt/src/xyz2grd.py Outdated
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@willschlitzer
willschlitzer requested a review from a teamOctober 25, 2021 09:50
Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py Outdated
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

@maxrjonesmaxrjones left a comment

Copy link
Copy Markdown
Member

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.

Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py
Comment threadpygmt/src/xyz2grd.py
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

@michaelgrundmichaelgrund left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
ContributorAuthor

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?

Comment threadpygmt/src/xyz2grd.py Outdated
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

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".

Comment threadpygmt/src/xyz2grd.py
Comment threadpygmt/src/xyz2grd.py
Comment threadpygmt/src/xyz2grd.py Outdated
Comment threadpygmt/src/xyz2grd.py Outdated
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@weiji14weiji14 changed the title Add missing aliases to xyz2grdAdd missing aliases to pygmt.xyz2grdOct 28, 2021
@weiji14
weiji14 merged commit d12470f into mainOct 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 <meghanj@alum.mit.edu>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@willschlitzer@maxrjones@seisman@michaelgrund@weiji14