Skip to content

utils.sequence_join: Remove parameter 'separator' (Deprecated since v0.17.0) #4346

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.

Sign up for GitHub

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

Merged
seisman merged 2 commits into from
Jan 17, 2026
+0 −19
Merged

utils.sequence_join: Remove parameter 'separator' (Deprecated since v0.17.0) #4346

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f09caa2
Remove parameter 'separator'
yvonnefroehlich Jan 13, 2026
1eec810
Merge branch 'main' into remove-sequence_join-separator
seisman Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions pygmt/helpers/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
import subprocess
import sys
import time
import warnings
import webbrowser
from collections.abc import Iterable, Mapping, Sequence
from itertools import islice
Expand Down Expand Up @@ -726,11 +725,9 @@ def args_in_kwargs(args: Sequence[str], kwargs: dict[str, Any]) -> bool:
)


# TODO(PyGMT>=0.19.0): Remove the deprecate_parameter decorator.
def sequence_join(
value: Any,
sep: str = "/",
separator: str | None = None,
size: int | Sequence[int] | None = None,
ndim: int = 1,
name: str | None = None,
Expand All @@ -747,12 +744,6 @@ def sequence_join(
The 1-D or 2-D sequence of values to join.
sep
The separator to join the values.
separator
The separator to join the values.

.. versionchanged:: v0.17.0

Deprecated and will be removed in v0.19.0. Use ``sep`` instead.
size
Expected size of the 1-D sequence. It can be either an integer or a sequence of
integers. If an integer, it is the expected size of the 1-D sequence. If it is a
Expand Down Expand Up @@ -815,8 +806,6 @@ def sequence_join(
pygmt.exceptions.GMTInvalidInput: Expected a sequence of 4 values.
>>> sequence_join([[1, 2], [3, 4]], sep="/", size=[2, 4], ndim=2)
['1/2', '3/4']
>>> sequence_join([1, 2, 3, 4], separator=",")
'1,2,3,4'

>>> # Join a sequence of datetime-like objects into a string.
>>> import datetime
Expand Down Expand Up @@ -847,14 +836,6 @@ def sequence_join(
return value
# Now it must be a sequence.

if separator is not None:
sep = separator # Deprecated, use sep instead.
msg = (
"Parameter 'separator' has been deprecated since v0.17.0 and will be "
"removed in v0.19.0. Please use 'sep' instead."
)
warnings.warn(msg, category=FutureWarning, stacklevel=2)

# Change size to a list to simplify the checks.
size = [size] if isinstance(size, int) else size
errmsg = {
Expand Down