Skip to content

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

Merged
weiji14 merged 42 commits into
mainfrom
add-select-aliases-CFL
Aug 31, 2023
Merged

pygmt.select: Add aliases for "C", "F", and "L"#2466
weiji14 merged 42 commits into
mainfrom
add-select-aliases-CFL

Conversation

@yvonnefroehlich

@yvonnefroehlichyvonnefroehlich commented Mar 29, 2023

Copy link
Copy Markdown
Member

Description of proposed changes

This PR aims to add aliases for pygmt.select:

  • C -> pointfiledist2pt
  • F -> polygonfilepolygon
  • L -> line_filedist2line

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

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

Copy link
Copy Markdown
MemberAuthor

/format

@yvonnefroehlichyvonnefroehlich mentioned this pull request Apr 25, 2023
7 tasks
Comment threadpygmt/src/select.py Outdated
Comment threadpygmt/src/select.py Outdated
Comment threadpygmt/src/select.py Outdated
@yvonnefroehlich
yvonnefroehlich marked this pull request as ready for review August 27, 2023 12:02
@yvonnefroehlichyvonnefroehlich added the needs review This PR has higher priority and needs review. label Aug 27, 2023
@yvonnefroehlichyvonnefroehlich 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
Comment threadpygmt/src/select.py Outdated
Comment threadpygmt/src/select.py Outdated

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

@weiji14weiji14 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 mainAug 31, 2023
@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>
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 14, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementImproving an existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@yvonnefroehlich@michaelgrund@weiji14@seisman