Skip to content

Deprecate the build_arg_string function in v0.12.0 (will be removed in v0.14.0) and use build_arg_list instead - #3184

Merged
seisman merged 3 commits into
mainfrom
deprecate/build_arg_string
Apr 22, 2024
Merged

Deprecate the build_arg_string function in v0.12.0 (will be removed in v0.14.0) and use build_arg_list instead#3184
seisman merged 3 commits into
mainfrom
deprecate/build_arg_string

Conversation

@seisman

Copy link
Copy Markdown
Member

Description of proposed changes

After PR #3149 and #3132, build_arg_string is no longer used anywhere so can be removed. However, although it's not a public API function, we know that someone are using it in their own wrappers (e.g., https://gist.github.com/yasuit21/db1d676d784769b80365a3528d1ab547), so better to raise a warning in the next few releases.

@seismanseisman added the deprecation Deprecating a feature label Apr 20, 2024
@seismanseisman added this to the 0.12.0 milestone Apr 20, 2024
Comment threadpygmt/helpers/utils.py Outdated
gmt_args = []
msg = (
"Utility function `build_arg_string()' is deprecated in v0.12.0 and will be "
"removed in v0.14.0. Uease `build_arg_list()' instead."

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

OK with removing the function in two releases?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, two releases should be fine since it's meant to be an internal function (though people still use it for good reason).

@seismanseisman added the needs review This PR has higher priority and needs review. label Apr 20, 2024
Comment threadpygmt/helpers/utils.py Outdated
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seismanseisman 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 Apr 21, 2024
Comment threadpygmt/helpers/utils.py
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
seisman merged commit da664bc into mainApr 22, 2024
@seisman
seisman deleted the deprecate/build_arg_string branch April 22, 2024 00:07
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 22, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deprecationDeprecating a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@seisman@michaelgrund@weiji14@yvonnefroehlich