sequence_join/_to_string/Alias: Deprecate parameter 'separator', use 'sep' instead. [Will be removed in v0.19.0] #4033
Conversation
This file contains hidden or 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
…'sep' instead. [Will be removed in v0.19.0]
seisman
added
maintenance
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the separator parameter in favor of the shorter sep parameter in sequence_join function and related alias functionality. The change aligns with common Python conventions used in libraries like pandas and the standard library.
- Adds deprecation warnings for
separatorparameter usage - Updates function signatures to use
sepas the primary parameter - Updates all existing code and documentation to use the new
sepparameter
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pygmt/tests/test_alias_system.py | Updates test code to use sep instead of separator |
| pygmt/helpers/utils.py | Implements deprecation logic and updates sequence_join function signature |
| pygmt/alias.py | Updates _to_string and Alias class to use sep parameter |
michaelgrund
approved these changes
Jul 31, 2025
seisman
added
final review call
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.
The parameter
separatoris a little too long, usesepinstead.sepis commonly used in the Python world, e.g., instr.splitandpandas.read_csv.sequence_jionwas added in v0.16.0 so it's a breaking change, but I guess very few users will usesequence_join. Theseparatorparameter is marked as deprecated and will be removed in v0.19.0.