Skip to content

Commit 1b6e71b

Browse files
committed
Add tests
1 parent 96b089d commit 1b6e71b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

pygmt/params/base.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,29 @@ class Alias(NamedTuple):
1212

1313

1414
class BaseParams:
15+
"""
16+
Examples
17+
--------
18+
>>> import dataclasses
19+
>>> from pygmt.params.base import BaseParams
20+
>>>
21+
>>> @dataclasses.dataclass(repr=False)
22+
... class Test(BaseParams):
23+
... attr1 : Any = None
24+
... attr2 : Any = None
25+
... attr3 : Any = None
26+
...
27+
... __aliases__ = [
28+
... Alias("attr1", ""),
29+
... Alias("attr2", "+a"),
30+
... Alias("attr3", "+b", "/"),
31+
... ]
32+
>>> var = Test(attr1="val1")
33+
>>> str(var)
34+
'val1'
35+
>>> repr(var)
36+
"Test(attr1='val1')"
37+
"""
1538
def __str__(self):
1639
values = []
1740
for alias in self.__aliases__:

0 commit comments

Comments
 (0)