Skip to content

Commit d844fd1

Browse files
authored
Remove sequence_space converter from kwargs_to_string (#3183)
No longer needed after build_arg_list was used in #3132.
1 parent 86cf1e2 commit d844fd1

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

pygmt/helpers/decorators.py

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,6 @@ def kwargs_to_strings(**conversions):
634634
string
635635
* 'sequence_comma': transforms a sequence into a ``','`` separated string
636636
* 'sequence_plus': transforms a sequence into a ``'+'`` separated string
637-
* 'sequence_space': transforms a sequence into a ``' '`` separated string
638637
639638
Parameters
640639
----------
@@ -645,7 +644,7 @@ def kwargs_to_strings(**conversions):
645644
646645
Examples
647646
--------
648-
>>> @kwargs_to_strings(R="sequence", i="sequence_comma", files="sequence_space")
647+
>>> @kwargs_to_strings(R="sequence", i="sequence_comma")
649648
... def module(*args, **kwargs):
650649
... "A module that prints the arguments it received"
651650
... print("{", end="")
@@ -670,7 +669,7 @@ def kwargs_to_strings(**conversions):
670669
>>> module(i=[1, 2])
671670
{'i': '1,2'}
672671
>>> module(files=["data1.txt", "data2.txt"])
673-
{'files': 'data1.txt data2.txt'}
672+
{'files': ['data1.txt', 'data2.txt']}
674673
>>> # Other non-boolean arguments are passed along as they are
675674
>>> module(123, bla=(1, 2, 3), foo=True, A=False, i=(5, 6))
676675
{'A': False, 'bla': (1, 2, 3), 'foo': True, 'i': '5,6'}
@@ -695,7 +694,6 @@ def kwargs_to_strings(**conversions):
695694
>>> # Here is a more realistic example
696695
>>> # See https://github.com/GenericMappingTools/pygmt/issues/2361
697696
>>> @kwargs_to_strings(
698-
... files="sequence_space",
699697
... offset="sequence",
700698
... R="sequence",
701699
... i="sequence_comma",
@@ -711,21 +709,20 @@ def kwargs_to_strings(**conversions):
711709
... )
712710
... print("}")
713711
>>> module(files=["data1.txt", "data2.txt"])
714-
data1.txt data2.txt -54p/-54p {}
712+
['data1.txt', 'data2.txt'] -54p/-54p {}
715713
>>> module(["data1.txt", "data2.txt"])
716-
data1.txt data2.txt -54p/-54p {}
714+
['data1.txt', 'data2.txt'] -54p/-54p {}
717715
>>> module(files=["data1.txt", "data2.txt"], offset=("20p", "20p"))
718-
data1.txt data2.txt 20p/20p {}
716+
['data1.txt', 'data2.txt'] 20p/20p {}
719717
>>> module(["data1.txt", "data2.txt"], ("20p", "20p"))
720-
data1.txt data2.txt 20p/20p {}
718+
['data1.txt', 'data2.txt'] 20p/20p {}
721719
>>> module(["data1.txt", "data2.txt"], ("20p", "20p"), R=[1, 2, 3, 4])
722-
data1.txt data2.txt 20p/20p {'R': '1/2/3/4'}
720+
['data1.txt', 'data2.txt'] 20p/20p {'R': '1/2/3/4'}
723721
"""
724722
separators = {
725723
"sequence": "/",
726724
"sequence_comma": ",",
727725
"sequence_plus": "+",
728-
"sequence_space": " ",
729726
}
730727

731728
for arg, fmt in conversions.items():

0 commit comments

Comments
 (0)