Skip to content

Commit 1968f3c

Browse files
committed
Improve the docstrings for perspective
1 parent b1468a6 commit 1968f3c

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

pygmt/helpers/decorators.py

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,12 +262,24 @@
262262
pen : str
263263
Set pen attributes for lines or the outline of symbols.""",
264264
"perspective": r"""
265-
perspective : list or str
266-
[**x**\|\ **y**\|\ **z**]\ *azim*\[/*elev*\[/*zlevel*]]\
267-
[**+w**\ *lon0*/*lat0*\[/*z0*]][**+v**\ *x0*/*y0*].
268-
Select perspective view and set the azimuth and elevation angle of
269-
the viewpoint [Default is ``[180, 90]``]. Full documentation is at
270-
:gmt-docs:`gmt.html#perspective-full`.""",
265+
perspective
266+
Select perspective view and set the azimuth and elevation of the viewpoint.
267+
268+
It can be specified as *azimuth*, (*azimuth*, *elevation*), or
269+
(*azimuth*, *elevation*, *zlevel*), in which,
270+
271+
- *azimuth*: Azimuth angle of the viewpoint in degrees [Default is 180,
272+
i.e., looking from south to north].
273+
- *elevation*: Elevation angle of the viewpoint above the horizon [Default
274+
is 90, i.e., looking straight down].
275+
- *zlevel*: Z-level at which 2-D elements (e.g., the map frame) are drawn.
276+
Only applies when used together with ``zsize``/``zscale``. [Default is at
277+
the bottom of the z-axis].
278+
279+
Alternatively, set ``perspective=True`` to use the perspective setting used
280+
in the previous plotting method. Or passing a string with the full GMT
281+
syntax to have more control. See :gmt-docs:`gmt.html#perspective-full` for
282+
details.""",
271283
"projection": r"""
272284
projection
273285
*projcode*\[*projparams*/]\ *width*\|\ *scale*.

0 commit comments

Comments
 (0)