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.

Sign up for GitHub

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

Jump to bottom

Figure.psconvert: Add new aliases and deprecate parameter "icc_gray" (remove in v0.8.0) #1673

Merged
merged 21 commits into from
Jan 12, 2022
Merged

Figure.psconvert: Add new aliases and deprecate parameter "icc_gray" (remove in v0.8.0) #1673

merged 21 commits into from
Jan 12, 2022

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Dec 17, 2021 •
edited by weiji14
Loading

Description of proposed changes

This PR updates the psconvert -A syntax to account for GMT 6.3 change made at GenericMappingTools/gmt#5583.

Preview at https://pygmt-git-update-psconvert-syntax-gmt.vercel.app/api/generated/pygmt.Figure.psconvert.html

Part of #1644

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.

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

@michaelgrund michaelgrund added the maintenance Boring but important stuff for the core devs label Dec 17, 2021
@michaelgrund michaelgrund added this to the 0.6.0 milestone Dec 17, 2021
@michaelgrund michaelgrund marked this pull request as draft December 17, 2021 17:59
@michaelgrund michaelgrund mentioned this pull request Dec 17, 2021
Closed
31 tasks
@michaelgrund michaelgrund changed the title Update psconvert -A syntax WIP Update psconvert -A syntax Dec 17, 2021
@michaelgrund
Copy link
Member Author

I'm not fully sure which parts need to be changed here @GenericMappingTools/pygmt-maintainers . Every change that was introduced in GenericMappingTools/gmt#5583?

@michaelgrund michaelgrund changed the title WIP Update psconvert -A syntax Update psconvert -A syntax Dec 21, 2021
@michaelgrund michaelgrund marked this pull request as ready for review December 21, 2021 08:04
@weiji14
Copy link
Member

weiji14 commented Dec 21, 2021

I'm not fully sure which parts need to be changed here @GenericMappingTools/pygmt-maintainers . Every change that was introduced in GenericMappingTools/gmt#5583?

I would also update -I (icc_gray) as a minimum since that is aliased. The changes in -N and -W could be done in a separate PR when we add long aliases for those.

@michaelgrund
Copy link
Member Author

I'm not fully sure which parts need to be changed here @GenericMappingTools/pygmt-maintainers . Every change that was introduced in GenericMappingTools/gmt#5583?

I would also update -I (icc_gray) as a minimum since that is aliased. The changes in -N and -W could be done in a separate PR when we add long aliases for those.

I agree, however, it seems like icc_gray isn't a good alias for -I anymore @weiji14.

weiji14
weiji14 reviewed Dec 21, 2021
View reviewed changes
pygmt/figure.py Outdated Show resolved Hide resolved
weiji14
weiji14 reviewed Jan 1, 2022
View reviewed changes
pygmt/figure.py Outdated Show resolved Hide resolved
pygmt/figure.py Outdated Show resolved Hide resolved
@michaelgrund michaelgrund removed the maintenance Boring but important stuff for the core devs label Jan 3, 2022
seisman
seisman reviewed Jan 8, 2022
View reviewed changes
pygmt/figure.py Outdated Show resolved Hide resolved
@seisman seisman changed the title Figure.psconvert: Deprecate parameter "icc_gray" to "resize" (remove in v0.8.0) Figure.psconvert: Add new aliases and deprecate parameter "icc_gray" (remove in v0.8.0) Jan 10, 2022
@seisman seisman added enhancement Improving an existing feature and removed deprecation Deprecating a feature labels Jan 10, 2022
seisman
seisman approved these changes Jan 11, 2022
View reviewed changes
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jan 11, 2022
weiji14
weiji14 approved these changes Jan 11, 2022
View reviewed changes
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.

Just one suggestion to check that the FutureWarning is emitted in the unit test, otherwise all good.

weiji14
weiji14 reviewed Jan 11, 2022
View reviewed changes
pygmt/tests/test_figure.py Outdated Show resolved Hide resolved
@seisman seisman merged commit 6e70e8b into main Jan 12, 2022
@seisman seisman deleted the update-psconvert-syntax branch January 12, 2022 07:58
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 12, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@michaelgrund @weiji14 @seisman
Figure.psconvert: Add new aliases and deprecate parameter "icc_gray" …
d70d371 
…(remove in v0.8.0) (GenericMappingTools#1673)

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
@seisman seisman mentioned this pull request Dec 22, 2022
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiji14 weiji14 weiji14 approved these changes

@willschlitzer willschlitzer willschlitzer approved these changes

@seisman seisman seisman approved these changes

Assignees
No one assigned
Labels
enhancement Improving an existing feature
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.
4 participants
@michaelgrund @weiji14 @seisman @willschlitzer