Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GMT argument in the cylindric projections gallery to doc standards #789

Merged
merged 16 commits into from
Jan 6, 2021
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion examples/projections/cyl/cyl_cassini.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
meridian, each meridian 90° away, and equator are straight lines; all other meridians
and parallels are complex curves.

``Clon0/lat0/width``: ``lon0`` and ``lat0`` specifies the projection center.
**c**\ *lon0/lat0*\ */scale* or **C**\ *lon0/lat0*\ */width*

The projection is set with **c** or **C**. The projection center is set by *lon0/lat0*,
and the figure size is set with *scale* or *width*.
"""
import pygmt

Expand Down
6 changes: 4 additions & 2 deletions examples/projections/cyl/cyl_equal_area.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
latitude is selected as the standard parallel. However, they are all equal area and
hence non-conformal. All meridians and parallels are straight lines.

``Ylon0/lat0/width``: Give central meridian ``lon0``, the standard parallel ``lat0``,
and the figure ``width``.
**y**\ *lon0/lat0*\ */scale* or **Y**\ *lon0/lat0*\ */width*

The projection is set with **y** or **Y**. The projection center is set by *lon0/lat0*,
and the figure size is set with *scale* or *width*.
"""
import pygmt

Expand Down
5 changes: 4 additions & 1 deletion examples/projections/cyl/cyl_equidistant.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
latitudes. The most common form is the Plate Carrée projection, where the scaling of
longitudes and latitudes is the same. All meridians and parallels are straight lines.

``Qwidth``: Give the figure ``width``.
**q**\ */scale* or **Q**\ */width*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

The projection is set with **q** or **Q**, and the figure size is set
with *scale* or *width*.
"""
import pygmt

Expand Down
7 changes: 5 additions & 2 deletions examples/projections/cyl/cyl_mercator.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@
extensively for world maps in which the distortion towards the polar regions grows
rather large.

``M[lon0/][lat0/]width``: Give central meridian ``lon0`` (optional) and
standard parallel ``lat0`` (optional).
**m**\ [*lon0[/lat0]*]\ */scale* or **M**\ [*lon0*][*/lat0*]\ */width*

The projection is set with **m** or **M**. The central meridian is set with the
option *lon0* and the standard parallel is set with the option *lat0*.
The figure size is set with *scale* or *width*.
"""
import pygmt

Expand Down
5 changes: 4 additions & 1 deletion examples/projections/cyl/cyl_miller.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
by using Mercator’s formula with 0.8 times the actual latitude, thus avoiding the
singular poles; the result was then divided by 0.8.

``J[lon0/]width``: Give the optional central meridian ``lon0`` and the figure ``width``.
**j**\ [*lon0/*]\ */scale* or **J**\ [*lon0/*]\ */width*

The projection is set with **j** or **J**. The central meridian is set by the
optional *lon0*, and the figure size is set with *scale* or *width*.
"""
import pygmt

Expand Down
9 changes: 6 additions & 3 deletions examples/projections/cyl/cyl_stereographic.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@
antipodal point on the equator. The cylinder crosses the sphere at two standard
parallels, equidistant from the equator.

``Cyl_stere/[lon0/][lat0/]width``: Give central meridian ``lon0`` (optional) and
standard parallel ``lat0`` (optional). The standard parallel is typically one of these
(but can be any value):
**cyl_stere/**\ [*lon0/*]\ [*lat0/*]*\ *scale*
or **Cyl_stere/**\ [*lon0/*]\ [*lat0/*]*\ *width*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
The projection is set with **cyl_stere** or **Cyl_stere**. The central meridian is set
by the optional *lon0*, and the figure size is set with *scale* or *width*.

The standard parallel is typically one of these (but can be any value):

* 66.159467 - Miller's modified Gall
* 55 - Kamenetskiy's First
Expand Down
7 changes: 5 additions & 2 deletions examples/projections/cyl/cyl_transverse_mercator.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
center. The central meridian, each meridian 90° away from the center, and equator are
straight lines; other parallels and meridians are complex curves.

``T[lon0/][lat0/]width``: Give central meridian ``lon0``, the latitude of the
origin ``lat0`` (optional), and the figure width.
**t**\ *lon0/*\ [*lat0/*\ ]\ *scale*or **T**\ *lon0/*\ [*lat0/*\ ]\ *width*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

The projection is set with **t** or **T**. The central meridian is set
by *lon0*, the latitude of the origin is set by the optional *lat0*, and the figure
size is set with *scale* or *width*.
"""
import pygmt

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
1 part in 1,000 from true scale at equator. The ellipsoidal projection expressions are
accurate for map areas that extend less than 10 away from the central meridian.

``U[UTM Zone/][lat0/]width``: Give UTM Zone ``UTM Zone``, and the figure width.
**u**\ *UTM Zone/scale* or **U**\ *UTM Zone/width*
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

the projection is set with *u* or *U*. *UTM Zone* sets the zone for the figure, and
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
the figure size is set wtih *scale* or *width*.
"""
import pygmt

Expand Down