Skip to content

Commit a75f22c

Browse files
committed
Improve docstring of frame
1 parent 00d17f4 commit a75f22c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

pygmt/params/frame.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
@dataclass(repr=False)
1313
class Axes(BaseParam):
1414
"""
15+
Class for setting up the axes, title, and fill of a plot.
16+
1517
Examples
1618
--------
1719
>>> from pygmt.params import Axes
@@ -35,6 +37,10 @@ def _aliases(self):
3537
@dataclass(repr=False)
3638
class Axis(BaseParam):
3739
"""
40+
Class for setting up one axis of a plot.
41+
42+
Examples
43+
--------
3844
>>> from pygmt.params import Axis
3945
>>> str(Axis(10, angle=30, label="X axis", unit="km"))
4046
'10+a30+lX axis+ukm'
@@ -58,6 +64,8 @@ def _aliases(self):
5864
@dataclass(repr=False)
5965
class Frame(BaseParam):
6066
"""
67+
Class for setting up the frame of a plot.
68+
6169
>>> from pygmt.alias import AliasSystem, Alias
6270
>>> from pygmt.params import Frame, Axes, Axis
6371
>>> frame = Frame(

0 commit comments

Comments
 (0)