Skip to content

Commit ad8a0e0

Browse files
Update GMT argument in the cylindric projections gallery to doc standards (#789)
* Update doc string for cyl_cassini.py * Updating doc string for cyl_equal_area.py * Updating doc string for cyl_equidistant.py * Updating doc string for cyl_mercator.py * Updating doc string for cyl_miller.py * Update doc string for cyl_stereographic.py * Update doc string for cyl_transverse_mercator.py * Update doc string for cyl_universal_transverse_mercator.py Co-authored-by: Dongdong Tian <[email protected]>
1 parent a40a075 commit ad8a0e0

File tree

8 files changed

+36
-13
lines changed

8 files changed

+36
-13
lines changed

examples/projections/cyl/cyl_cassini.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@
1111
meridian, each meridian 90° away, and equator are straight lines; all other meridians
1212
and parallels are complex curves.
1313
14-
``Clon0/lat0/width``: ``lon0`` and ``lat0`` specifies the projection center.
14+
**c**\ *lon0/lat0*\ */scale* or **C**\ *lon0/lat0*\ */width*
15+
16+
The projection is set with **c** or **C**. The projection center is set by *lon0/lat0*,
17+
and the figure size is set with *scale* or *width*.
1518
"""
1619
import pygmt
1720

examples/projections/cyl/cyl_equal_area.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
latitude is selected as the standard parallel. However, they are all equal area and
77
hence non-conformal. All meridians and parallels are straight lines.
88
9-
``Ylon0/lat0/width``: Give central meridian ``lon0``, the standard parallel ``lat0``,
10-
and the figure ``width``.
9+
**y**\ *lon0/lat0*\ */scale* or **Y**\ *lon0/lat0*\ */width*
10+
11+
The projection is set with **y** or **Y**. The projection center is set by *lon0/lat0*,
12+
and the figure size is set with *scale* or *width*.
1113
"""
1214
import pygmt
1315

examples/projections/cyl/cyl_equidistant.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
latitudes. The most common form is the Plate Carrée projection, where the scaling of
77
longitudes and latitudes is the same. All meridians and parallels are straight lines.
88
9-
``Qwidth``: Give the figure ``width``.
9+
**q**\ *scale* or **Q**\ *width*
10+
11+
The projection is set with **q** or **Q**, and the figure size is set
12+
with *scale* or *width*.
1013
"""
1114
import pygmt
1215

examples/projections/cyl/cyl_mercator.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
extensively for world maps in which the distortion towards the polar regions grows
1313
rather large.
1414
15-
``M[lon0/][lat0/]width``: Give central meridian ``lon0`` (optional) and
16-
standard parallel ``lat0`` (optional).
15+
**m**\ [*lon0[/lat0]*]\ */scale* or **M**\ [*lon0*][*/lat0*]\ */width*
16+
17+
The projection is set with **m** or **M**. The central meridian is set with the
18+
option *lon0* and the standard parallel is set with the option *lat0*.
19+
The figure size is set with *scale* or *width*.
1720
"""
1821
import pygmt
1922

examples/projections/cyl/cyl_miller.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@
99
by using Mercator’s formula with 0.8 times the actual latitude, thus avoiding the
1010
singular poles; the result was then divided by 0.8.
1111
12-
``J[lon0/]width``: Give the optional central meridian ``lon0`` and the figure ``width``.
12+
**j**\ [*lon0/*]\ */scale* or **J**\ [*lon0/*]\ */width*
13+
14+
The projection is set with **j** or **J**. The central meridian is set by the
15+
optional *lon0*, and the figure size is set with *scale* or *width*.
1316
"""
1417
import pygmt
1518

examples/projections/cyl/cyl_stereographic.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@
1010
antipodal point on the equator. The cylinder crosses the sphere at two standard
1111
parallels, equidistant from the equator.
1212
13-
``Cyl_stere/[lon0/][lat0/]width``: Give central meridian ``lon0`` (optional) and
14-
standard parallel ``lat0`` (optional). The standard parallel is typically one of these
15-
(but can be any value):
13+
**cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *scale*
14+
or **Cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *width*
15+
The projection is set with **cyl_stere** or **Cyl_stere**. The central meridian is set
16+
by the optional *lon0*, and the figure size is set with *scale* or *width*.
17+
18+
The standard parallel is typically one of these (but can be any value):
1619
1720
* 66.159467 - Miller's modified Gall
1821
* 55 - Kamenetskiy's First

examples/projections/cyl/cyl_transverse_mercator.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88
center. The central meridian, each meridian 90° away from the center, and equator are
99
straight lines; other parallels and meridians are complex curves.
1010
11-
``T[lon0/][lat0/]width``: Give central meridian ``lon0``, the latitude of the
12-
origin ``lat0`` (optional), and the figure width.
11+
**t**\ *lon0/*\ [*lat0/*\ ]\ *scale* or **T**\ *lon0/*\ [*lat0/*\ ]\ *width*
12+
13+
The projection is set with **t** or **T**. The central meridian is set
14+
by *lon0*, the latitude of the origin is set by the optional *lat0*, and the figure
15+
size is set with *scale* or *width*.
1316
"""
1417
import pygmt
1518

examples/projections/cyl/cyl_universal_transverse_mercator.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
1 part in 1,000 from true scale at equator. The ellipsoidal projection expressions are
1515
accurate for map areas that extend less than 10 away from the central meridian.
1616
17-
``U[UTM Zone/][lat0/]width``: Give UTM Zone ``UTM Zone``, and the figure width.
17+
**u**\ *zone/scale* or **U**\ *zone/width*
18+
19+
the projection is set with **u** or **U**. *zone* sets the zone for the figure, and
20+
the figure size is set wtih *scale* or *width*.
1821
"""
1922
import pygmt
2023

0 commit comments

Comments
 (0)