Skip to content

Figure.meca: Add aliases for C, E, G, and W#2345

Merged
seisman merged 27 commits intomainfrom
add-meca-aliases-E-G
Feb 19, 2023
Merged

Figure.meca: Add aliases for C, E, G, and W#2345
seisman merged 27 commits intomainfrom
add-meca-aliases-E-G

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Feb 1, 2023

Description of proposed changes
This PR aims to add aliases for pygmt.Figure.meca:

  • add aliases
    • C -> cmap
    • E -> extensionfill
    • G -> compressionfill
    • W -> pen
  • [ ] add unit test

Related to comments #2329 (comment), #2329 (comment), and #2329 (comment).

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 Feb 1, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.9.0 milestone Feb 1, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Feb 1, 2023
@yvonnefroehlich yvonnefroehlich changed the title pygmt.Figure.meca: Add aliases for E and G WIP: pygmt.Figure.meca: Add aliases for E and G Feb 1, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft February 1, 2023 20:17
@yvonnefroehlich yvonnefroehlich mentioned this pull request Feb 3, 2023
17 tasks
@seisman
Copy link
Member

seisman commented Feb 12, 2023

@yvonnefroehlich Is this PR finished? I don't think a unit test is necessary, because this PR only adds aliases, and we're confident that aliases work.

@seisman
Copy link
Member

seisman commented Feb 12, 2023

BTW, could you please split this PR into two separate PRs: one for the docstring changes and another one for the new aliases.

@yvonnefroehlich
Copy link
Member Author

BTW, could you please split this PR into two separate PRs: one for the docstring changes and another one for the new aliases.

I submitted a separate PR #2360 for the docstring changes.

@yvonnefroehlich Is this PR finished?

Yes, this PR should be finished.
But I think, I like to add also aliases for W -> pen and C -> cmap. But I can do this in a separate PR 🙂.

I don't think a unit test is necessary, because this PR only adds aliases, and we're confident that aliases work.

This is fine with me, but I have experience with testing code... Adding a unit test was suggested in #2345 (comment).

@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Feb 12, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review February 12, 2023 09:48
@seisman
Copy link
Member

seisman commented Feb 12, 2023

Yes, this PR should be finished.
But I think, I like to add also aliases for W -> pen and C -> cmap. But I can do this in a separate PR .

It depends on you. You can keep working in this PR if you want to add more aliases.

@yvonnefroehlich yvonnefroehlich removed the needs review This PR has higher priority and needs review. label Feb 12, 2023
@yvonnefroehlich yvonnefroehlich changed the title WIP: pygmt.Figure.meca: Add aliases for E and G WIP: pygmt.Figure.meca: Add aliases for C, E, G, and W Feb 12, 2023
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Feb 17, 2023
@seisman seisman changed the title WIP: pygmt.Figure.meca: Add aliases for C, E, G, and W Figure.meca: Add aliases for C, E, G, and W Feb 17, 2023
@seisman seisman 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 Feb 18, 2023
yvonnefroehlich and others added 2 commits February 18, 2023 10:03
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman merged commit 2dfd01e into main Feb 19, 2023
@seisman seisman deleted the add-meca-aliases-E-G branch February 19, 2023 01:21
@yvonnefroehlich yvonnefroehlich removed the final review call This PR requires final review and approval from a second reviewer label Mar 29, 2023
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.

3 participants