Deprecate the build_arg_string function in v0.12.0 (will be removed in v0.14.0) and use build_arg_list instead #3184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n v0.14.0) and use build_arg_list instead
seisman
commented
Apr 20, 2024
pygmt/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." |
There was a problem hiding this comment.
OK with removing the function in two releases?
There was a problem hiding this comment.
Yes, two releases should be fine since it's meant to be an internal function (though people still use it for good reason).
michaelgrund
approved these changes
Apr 21, 2024
Co-authored-by: Michael Grund <[email protected]>
seisman
added
final review call
Co-authored-by: Yvonne Fröhlich <[email protected]>
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
After PR #3149 and #3132,
build_arg_stringis 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.