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

pygmt.select: Add aliases for "C", "F", and "L" #2466

Merged
merged 42 commits into from Aug 31, 2023
Merged

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Mar 29, 2023

Description of proposed changes

This PR aims to add aliases for pygmt.select:

  • C -> pointfile dist2pt
  • F -> polygonfile polygon
  • L -> line_file dist2line

The aliases are currently based on the Julia documentation at
https://joa-quim.github.io/GMTjl_doc/documentation/modules/gmtselect/index.html.

Preview: https://pygmt-dev--2466.org.readthedocs.build/en/2466/api/generated/pygmt.select.html

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@yvonnefroehlich yvonnefroehlich added the enhancement Improving an existing feature label Mar 29, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone Mar 29, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 29, 2023
@yvonnefroehlich yvonnefroehlich changed the title pygmt.select: Add aliases for C, F, and L WIP: pygmt.select: Add aliases for C, F, and L Mar 29, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft March 29, 2023 11:01
@yvonnefroehlich yvonnefroehlich changed the title WIP: pygmt.select: Add aliases for C, F, and L WIP: pygmt.select: Add aliases for "C", "F", and "L" Mar 31, 2023
@yvonnefroehlich
Copy link
Member Author

/format

@yvonnefroehlich yvonnefroehlich mentioned this pull request Apr 25, 2023
7 tasks
pygmt/src/select.py Outdated Show resolved Hide resolved
pygmt/src/select.py Outdated Show resolved Hide resolved
pygmt/src/select.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review August 27, 2023 12:02
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Aug 27, 2023
@yvonnefroehlich yvonnefroehlich changed the title WIP: pygmt.select: Add aliases for "C", "F", and "L" pygmt.select: Add aliases for "C", "F", and "L" Aug 27, 2023
pygmt/src/select.py Outdated Show resolved Hide resolved
pygmt/src/select.py Outdated Show resolved Hide resolved
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.

@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Aug 30, 2023
@weiji14 weiji14 enabled auto-merge (squash) August 31, 2023 10:22
@weiji14 weiji14 merged commit 1d8c0fd into main Aug 31, 2023
16 checks passed
@weiji14 weiji14 deleted the add-select-aliases-CFL branch August 31, 2023 10:34
weiji14 added a commit that referenced this pull request Aug 31, 2023
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 14, 2024
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.

None yet

4 participants