We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 96b089d commit 1b6e71bCopy full SHA for 1b6e71b
pygmt/params/base.py
@@ -12,6 +12,29 @@ class Alias(NamedTuple):
12
13
14
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
38
def __str__(self):
39
values = []
40
for alias in self.__aliases__:
0 commit comments