Skip to content

Commit e5e25cf

Browse files
Update GMT argument in the miscellaneous projections gallery to doc standards (#790)
* Update doc string for misc_eckertIV.py * Update doc string for misc_eckertVI.py * Update doc string for misc_hammer.py * Update doc string for misc_mollweide.py * Update doc string for misc_robinson.py * Update doc string for misc_sinusoidal.py * Update doc string for misc_van_der_grinten.py * Update doc string for misc_winkel_tripel.py
1 parent ad8a0e0 commit e5e25cf

File tree

9 files changed

+34
-16
lines changed

9 files changed

+34
-16
lines changed

examples/projections/cyl/cyl_stereographic.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
1313
**cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *scale*
1414
or **Cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *width*
15+
1516
The projection is set with **cyl_stere** or **Cyl_stere**. The central meridian is set
1617
by the optional *lon0*, and the figure size is set with *scale* or *width*.
1718

examples/projections/misc/misc_eckertIV.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
meridian and all parallels are straight lines; other meridians are equally spaced
88
elliptical arcs. The scale is true along latitude 40°30’.
99
10-
``Kf[central meridian]/width``: Give the optional central meridian (default is the
11-
center of the region) and the map width.
10+
**kf**\ [*lon0/*]\ *scale* or **Kf**\ [*lon0/*]\ *width*
11+
12+
The projection is set with **kf** or **Kf**. The central meridian is set with the
13+
optional *lon0*, and the figure size is set with *scale* or *width*.
1214
"""
1315
import pygmt
1416

examples/projections/misc/misc_eckertVI.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@
77
Central meridian and all parallels are straight lines; other meridians are equally
88
spaced sinusoids. The scale is true along latitude 49°16’.
99
10-
``Ks[central meridian]/width``: Give the optional central meridian (default is the
11-
center of the region) and the map width.
10+
11+
**ks**\ [*lon0/*]\ *scale* or **Ks**\ [*lon0/*]\ *width*
12+
13+
The projection is set with **ks** or **Ks**. The central meridian is set with the
14+
optional *lon0*, and the figure size is set with *scale* or *width*.
1215
"""
1316
import pygmt
1417

examples/projections/misc/misc_hammer.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
similar, but is not equal-area). The border is an ellipse, equator and central
88
meridian are straight lines, while other parallels and meridians are complex curves.
99
10-
``H[central meridian]/width``: Give the optional central meridian (default is the center
11-
of the region) and the map width.
10+
**h**\ [*lon0/*]\ *scale* or **H**\ [*lon0/*]\ *width*
11+
12+
The projection is set with **h** or **H**. The central meridian is set with the
13+
optional *lon0*, and the figure size is set with *scale* or *width*.
1214
"""
1315
import pygmt
1416

examples/projections/misc/misc_mollweide.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@
99
mainly for global maps showing data distributions. It is occasionally referenced under
1010
the name homalographic projection.
1111
12-
``W[central meridian]/width``: Give the optional central meridian (default is the center
13-
of the region) and the map width.
12+
**w**\ [*lon0/*]\ *scale* or **W**\ [*lon0/*]\ *width*
13+
14+
The projection is set with **w** or **W**. The central meridian is set with the
15+
optional *lon0*, and the figure size is set with *scale* or *width*.
1416
"""
1517
import pygmt
1618

examples/projections/misc/misc_robinson.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@
1010
originally developed for use by Rand McNally and is currently used by the
1111
National Geographic Society.
1212
13-
``N[central meridian]/width``: Give the optional central meridian (default is the center
14-
of the region) and the map width.
13+
**n**\ [*lon0/*]\ *scale* or **N**\ [*lon0/*]\ *width*
14+
15+
The projection is set with **n** or **N**. The central meridian is set with the
16+
optional *lon0*, and the figure size is set with *scale* or *width*.
1517
"""
1618
import pygmt
1719

examples/projections/misc/misc_sinusoidal.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88
meridians are sinusoidal curves. Parallels are all equally spaced straight lines, with
99
scale being true along all parallels (and central meridian).
1010
11-
``I[central meridian]/width``: Give the optional central meridian (default is the center
12-
of the region) and the map width.
11+
**i**\ [*lon0/*]\ *scale* or **I**\ [*lon0/*]\ *width*
12+
13+
The projection is set with **i** or **I**. The central meridian is set with the
14+
optional *lon0*, and the figure size is set with *scale* or *width*.
1315
"""
1416
import pygmt
1517

examples/projections/misc/misc_van_der_grinten.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
other meridians are arcs of circles. The scale is true along the Equator only. Its
88
main use is to show the entire world enclosed in a circle.
99
10-
``V[central meridian]/width``: Give the optional central meridian (default is the center
11-
of the region) and the map width.
10+
**v**\ [*lon0/*]\ *scale* or **V**\ [*lon0/*]\ *width*
11+
12+
The projection is set with **v** or **V**. The central meridian is set with the
13+
optional *lon0*, and the figure size is set with *scale* or *width*.
1214
"""
1315
import pygmt
1416

examples/projections/misc/misc_winkel_tripel.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@
1616
(not Hammer-Aitoff) projections. The poles map into straight lines 0.4 times the
1717
length of equator.
1818
19-
``R[central meridian]/width``: Give the optional central meridian (default is the center
20-
of the region) and the map width.
19+
**r**\ [*lon0/*]\ *scale* or **R**\ [*lon0/*]\ *width*
20+
21+
The projection is set with **r** or **R**. The central meridian is set with the
22+
optional *lon0*, and the figure size is set with *scale* or *width*.
2123
"""
2224
import pygmt
2325

0 commit comments

Comments
 (0)