Add a helper function sequence_join to join a sequence by a separator #3961
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
seisman
force-pushed
the
sequence_join
branch
3 times, most recently
from
49fa01a to
9ee2a21
Compare
seisman
added
enhancement
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new helper function, sequence_join, to join 1-D or 2-D sequences with a specified separator and replaces the older _parse_sequence calls in grdclip.
- Replaces _parse_sequence with sequence_join in grdclip.
- Adds the sequence_join implementation in pygmt/helpers/utils.py with extensive docstrings and examples.
- Updates pygmt/helpers/init.py to export the new helper function.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pygmt/src/grdclip.py | Updated to use the new sequence_join helper for joining sequences. |
| pygmt/helpers/utils.py | Added the implementation of sequence_join with parameter validations. |
| pygmt/helpers/init.py | Exported the newly added sequence_join for module-wide usage. |
weiji14
approved these changes
Jun 3, 2025
| ) | ||
|
|
||
|
|
||
| def sequence_join( |
Member
There was a problem hiding this comment.
Keep this as a private function?
Suggested change
| def sequence_join( | |
| def _sequence_join( |
Member
Author
There was a problem hiding this comment.
This function is used in grdclip.py and will likely be used in many other functions. So, I'd prefer to make it public.
Member
There was a problem hiding this comment.
Ok, not strong opinions, just worried we might need to refactor it again in the future (which requires more caution for public-facing functions).
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
This PR extends the private
_parse_sequencefunction ingrdclipto a more general functionsequence_join, which can join a 1-D or 2-D sequence by a separator.