Skip to content

Commit 02ae339

Browse files
committed
Improve docstrings
1 parent 88bcf72 commit 02ae339

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pygmt/params/perspective.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,23 @@ class Perspective(BaseParam):
2525
#: directly above).
2626
elevation: float | None = None
2727

28-
#: The z-level at which all 2D material, like the plot frame, is plotted (only valid
29-
#: when used in consort with ``zsize``/``zscale`` [Default is at the bottom of the
30-
#: z-axis].
28+
#: The z-level at which all 2-D material, like the plot frame, is plotted (only
29+
#: valid when used in consort with parameters ``zsize``/``zscale``. Default is at
30+
#: the bottom of the z-axis].
3131
zlevel: float | None = None
3232

33-
#: The plane to plot against the wall x = level (using x) or y = level (using y)
34-
#: or the horizontal plain (using z) [default is z].
33+
#: The plane to plot against the "wall" x = level (using x) or y = level (using y)
34+
#: or the horizontal plain (using z). Default is the z-plane.
3535
plane: Literal["x", "y", "z"] | None = None
3636

3737
#: For frames used for animation, the center of the data domain is fixed. Specify
38-
#: another center using one of the following parameters:
39-
40-
#: (*lon0*, *lat0*) or (*lon0*, *lat0*, *z0*).
41-
#: Project the specified coordinate to the center of the page size.
38+
#: another center using either parameters ``center`` or ``viewpoint``.
39+
#:
40+
#: Project the coordinate (*lon0*, *lat0*) or (*lon0*, *lat0*, *z0*) to the center
41+
#: of the page size.
4242
center: Sequence[float] | None = None
4343

44-
#: (*x0*, *y0*). Specify the center in the projected coordinate system.
44+
#: Specify the coordinates (*x0*, *y0*) of the projected 2-D view point.
4545
viewpoint: Sequence[float] | None = None
4646

4747
def __post_init__(self):

0 commit comments

Comments
 (0)