Skip to content

Commit c6ae82d

Browse files
Update GMT argument in the conic projections gallery to doc standards (#780)
* Updating documentation for conic_albers.py * Updating documentation for conic_equidistant.py * Update docstring for conic_lambert.py * Update docstring for polyconic.py * Changing conic projection gallery docstrings to r-strings
1 parent 85f087b commit c6ae82d

File tree

4 files changed

+26
-11
lines changed

4 files changed

+26
-11
lines changed

examples/projections/conic/conic_albers.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""
1+
r"""
22
Albers Conic Equal Area
33
=======================
44
@@ -11,8 +11,12 @@
1111
Between them, the scale along parallels is too small; beyond them it is too large.
1212
The opposite is true for the scale along meridians.
1313
14-
``Blon0/lat0/lat1/lat2/width``: Give projection center ``lon0/lat0`` and two standard
15-
parallels ``lat1/lat2``.
14+
**b**\ *lon0/lat0*\ /\ *lat1/lat2*\ */scale*
15+
or **B**\ *lon0/lat0*\ /\ *lat1/lat2*\ */width*
16+
17+
The projection is set with **b** or **B**. The projection center is set by *lon0/lat0*
18+
and two standard parallels for the map are set with *lat1/lat2*. The figure size is set
19+
with *scale* or *width*.
1620
"""
1721
import pygmt
1822

examples/projections/conic/conic_equidistant.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""
1+
r"""
22
Equidistant conic
33
=================
44
@@ -7,8 +7,12 @@
77
compromise between them. The scale is true along all meridians and the
88
standard parallels.
99
10-
``Dlon0/lat0/lat1/lat2/width``: Give projection center ``lon0/lat0``, two standard
11-
parallels ``lat1/lat2``, and the map width.
10+
**d**\ *lon0/lat0*\ /\ *lat1/lat2*\ */scale*
11+
or **D**\ *lon0/lat0*\ /\ *lat1/lat2*\ */width*
12+
13+
The projection is set with **d** or **D**. The projection center is set by *lon0/lat0*
14+
and two standard parallels for the map are set with *lat1/lat2*. The figure size is set
15+
with *scale* or *width*.
1216
"""
1317
import pygmt
1418

examples/projections/conic/conic_lambert.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""
1+
r"""
22
Lambert Conic Conformal Projection
33
==================================
44
@@ -9,8 +9,12 @@
99
with a common origin, and meridians are the equally spaced radii of these circles. As
1010
with Albers projection, it is only the two standard parallels that are distortion-free.
1111
12-
``Llon0/lat0/lat1/lat2/width``: Give projection center ``lon0/lat0``, two standard
13-
parallels ``lat1/lat2``, and the map width.
12+
**l**\ *lon0/lat0*\ /\ *lat1/lat2*\ */scale*
13+
or **L**\ *lon0/lat0*\ /\ *lat1/lat2*\ */width*
14+
15+
The projection is set with **l** or **L**. The projection center is set by *lon0/lat0*
16+
and two standard parallels for the map are set with *lat1/lat2*. The figure size is set
17+
with *scale* or *width*.
1418
"""
1519
import pygmt
1620

examples/projections/conic/polyconic.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""
1+
r"""
22
Polyconic Projection
33
====================
44
@@ -18,7 +18,10 @@
1818
consequence, no parallel is standard because conformity is lost with the lengthening of
1919
the meridians.
2020
21-
``Poly/width``: The only additional argument for the projection is the map width.
21+
**poly**\ */scale* or **Poly**\ */width*
22+
23+
The projection is set with **poly** or **Poly**. The figure size is set
24+
with *scale* or *width*.
2225
"""
2326
import pygmt
2427

0 commit comments

Comments
 (0)