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.

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

Figure.timestamp: Deprecate parameter 'justification' to 'justify' (remove in v0.13.0) #3002

Merged
merged 8 commits into from
Jan 19, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Jan 15, 2024

Description of proposed changes

We use the parameter justify in many modules (e.g., text, plot) but use justification in Figure.timestamp. This PR deprecates the justification parameter to justify to make it consistent in the project.

FYI, the GMT project also use justify as the long option name: https://github.com/GenericMappingTools/gmt/blob/0c3435fba382755a87ba7629cbe1db288c2a9a60/src/gmt_common_longoptions.h#L86

Since it's a rarely used module, I think it's OK to fully remove the deprecated parameter after two releases (i.e., v0.13.0).

@seisman seisman added deprecation Deprecating a feature needs review This PR has higher priority and needs review. labels Jan 15, 2024
@seisman seisman added this to the 0.11.0 milestone Jan 15, 2024
Copy link
Contributor

github-actions bot commented Jan 15, 2024

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path
renamed pygmt/tests/baseline/test_timestamp_justification.png -> pygmt/tests/baseline/test_timestamp_justify.png

Image diff(s)

Added images

Modified images

Path Old New

Report last updated at commit bcb668d

@seisman
Copy link
Member Author

seisman commented Jan 15, 2024

Although Figure.timestamp is rarely used, I think it's our first wrapper which

So, it's time to give this method a final review, then we can categorize it as "Ongoing maintenance".

@seisman seisman removed the needs review This PR has higher priority and needs review. label Jan 19, 2024
@seisman seisman merged commit 08edce2 into main Jan 19, 2024
19 of 20 checks passed
@seisman seisman deleted the timestamp/deprecate-justify branch January 19, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants