-
Notifications
You must be signed in to change notification settings - Fork 235
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
Conversation
49af570 to
7046f57
Compare
7046f57 to
ee00133
Compare
f52722f to
24405f0
Compare
There was a problem hiding this 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"fromuse_aliasdecorators and adds explicitpanelparameters to function signatures - Updates
kwargs_to_stringsdecorators to removec="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]>
|
Ping @GenericMappingTools/pygmt-maintainers for final reviews. I plan to merge it in 24 hours. |
As the PR title says.