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 sphdistance #1516

Merged
merged 7 commits into from
Oct 27, 2021
Merged

Add missing aliases to sphdistance #1516

merged 7 commits into from
Oct 27, 2021

Conversation

willschlitzer
Copy link
Contributor

This pull request is a follow up to #1383, and wraps additional optional parameters for sphdistance.

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 17, 2021
@willschlitzer willschlitzer added this to the 0.5.0 milestone Sep 17, 2021
@willschlitzer willschlitzer self-assigned this Sep 17, 2021
@weiji14 weiji14 added documentation Improvements or additions to documentation and removed enhancement Improving an existing feature labels Oct 5, 2021
@willschlitzer willschlitzer changed the title Add optional parameters to sphdistance Add missing aliases to sphdistance Oct 5, 2021
@willschlitzer willschlitzer marked this pull request as ready for review October 5, 2021 18:54
@willschlitzer willschlitzer added the skip-changelog Skip adding Pull Request to changelog label Oct 5, 2021
pygmt/src/sphdistance.py Outdated Show resolved Hide resolved
pygmt/src/sphdistance.py Outdated Show resolved Hide resolved
pygmt/src/sphdistance.py Outdated Show resolved Hide resolved
Comment on lines +72 to +79
Read the information pertaining to each Voronoi
polygon (the unique node lon, lat and polygon area) from a separate
file [Default acquires this information from the ASCII segment
headers of the output file]. Required if binary input via `voronoi`
is used.
voronoi : str
Append the name of a file with pre-calculated Voronoi polygons
[Default performs the Voronoi construction on input data].
Copy link
Member

Choose a reason for hiding this comment

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

Especially one sphtriangulate is wrapped, we will need to open a separate issue to discuss how to pass these data to sphdistance from memory rather than relying on writing/reading files.

@willschlitzer willschlitzer mentioned this pull request Oct 7, 2021
35 tasks
pygmt/src/sphdistance.py Outdated Show resolved Hide resolved
Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
@maxrjones
Copy link
Member

@willschlitzer, would you mind merging main into this branch to fix the vercel preview?

@willschlitzer willschlitzer requested a review from a team October 25, 2021 09:54
pygmt/src/sphdistance.py Outdated Show resolved Hide resolved
Copy link
Member

@seisman seisman 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 to me.

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed skip-changelog Skip adding Pull Request to changelog labels Oct 25, 2021
@willschlitzer
Copy link
Contributor Author

@GenericMappingTools/pygmt-admin Could I get one of the admins to merge this? I'm not able to with the failed windows-latest test.

@seisman seisman merged commit 8ea26d8 into main Oct 27, 2021
@seisman seisman deleted the add-params-sphdistance branch October 27, 2021 03:17
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 27, 2021
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
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants