Skip to content

Migrate the 'panel' parameter to the new alias system #4030

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

seisman
Copy link
Member

@seisman seisman commented Jul 30, 2025

As the PR title says.

@seisman seisman added this to the 0.17.0 milestone Jul 30, 2025
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Jul 30, 2025
@seisman seisman force-pushed the AliasSystem/panel branch from 49af570 to 7046f57 Compare July 30, 2025 11:03
@seisman seisman requested a review from Copilot July 30, 2025 11:27
Copilot

This comment was marked as outdated.

@seisman seisman force-pushed the AliasSystem/panel branch from 7046f57 to ee00133 Compare July 31, 2025 08:40
@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 Jul 31, 2025
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jul 31, 2025
@seisman seisman marked this pull request as draft August 2, 2025 16:47
@seisman seisman force-pushed the AliasSystem/panel branch from f52722f to 24405f0 Compare August 20, 2025 14:51
@seisman seisman marked this pull request as ready for review August 20, 2025 15:33
@seisman seisman added the needs review This PR has higher priority and needs review. label Aug 20, 2025
@seisman seisman requested a review from Copilot August 20, 2025 15:37
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR migrates the 'panel' parameter from the old use_alias decorator system to the new alias system across multiple PyGMT source files. The migration standardizes how the panel parameter is handled by moving it from short-form GMT option mappings to explicit parameter definitions in function signatures.

  • Removes c="panel" from use_alias decorators and adds explicit panel parameters to function signatures
  • Updates kwargs_to_strings decorators to remove c="sequence_comma" conversions
  • Integrates panel handling through the new AliasSystem.add_common() method

Reviewed Changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
pygmt/src/wiggle.py Migrates panel parameter from alias decorator to function signature
pygmt/src/velo.py Migrates panel parameter from alias decorator to function signature
pygmt/src/tilemap.py Migrates panel parameter from alias decorator to function signature
pygmt/src/text.py Migrates panel parameter from alias decorator to function signature
pygmt/src/ternary.py Migrates panel parameter from alias decorator to function signature
pygmt/src/solar.py Migrates panel parameter from alias decorator to function signature
pygmt/src/rose.py Migrates panel parameter and adds AliasSystem import
pygmt/src/plot3d.py Migrates panel parameter from alias decorator to function signature
pygmt/src/plot.py Migrates panel parameter from alias decorator to function signature
pygmt/src/meca.py Migrates panel parameter from alias decorator to function signature
pygmt/src/logo.py Migrates panel parameter from alias decorator to function signature
pygmt/src/legend.py Migrates panel parameter from alias decorator to function signature
pygmt/src/image.py Migrates panel parameter from alias decorator to function signature
pygmt/src/histogram.py Migrates panel parameter from alias decorator to function signature
pygmt/src/grdview.py Migrates panel parameter from alias decorator to function signature
pygmt/src/grdimage.py Migrates panel parameter from alias decorator to function signature
pygmt/src/grdcontour.py Migrates panel parameter from alias decorator to function signature
pygmt/src/contour.py Migrates panel parameter from alias decorator to function signature
pygmt/src/colorbar.py Migrates panel parameter from alias decorator to function signature
pygmt/src/coast.py Migrates panel parameter from alias decorator to function signature
pygmt/src/basemap.py Migrates panel parameter from alias decorator to function signature
pygmt/helpers/decorators.py Updates panel parameter documentation to remove type information
pygmt/alias.py Implements add_common method for handling common parameters like panel

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant