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

Fix typos in syntax of the projection documentation #2269

Merged
merged 11 commits into from
Dec 26, 2022
3 changes: 2 additions & 1 deletion examples/projections/conic/polyconic.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
central meridian. As a consequence, no parallel is standard because conformity
is lost with the lengthening of the meridians.

**poly**\ */scale* or **Poly**\ */width*
**poly**/\ [*lon0*/\ [*lat0*/]]\ *scale* or
**Poly**/\ [*lon0*/\ [*lat0*/]]\ *width*

The projection is set with **poly** or **Poly**. The figure size is set
with *scale* or *width*.
Expand Down
7 changes: 5 additions & 2 deletions examples/projections/cyl/cyl_equidistant.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@
scaling of longitudes and latitudes is the same. All meridians and parallels
are straight lines.

**q**\ *scale* or **Q**\ *width*
**q**\ [*lon0*/\ [*lat0*/]]\ *scale* or **Q**\ [*lon0*/\ [*lat0*/]]\ *width*

The projection is set with **q** or **Q**, and the figure size is set with
*scale* or *width*.
*scale* or *width*. Optionally, the central meridian can be set with *lon0*
[Default is the middle of the map]. Optionally, the standard parallel can
be set with *lat0* [Default is the equator]. When supplied, the central
meridian must be supplied as well.
"""
import pygmt

Expand Down
2 changes: 1 addition & 1 deletion examples/projections/cyl/cyl_mercator.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
for world maps in which the distortion towards the polar regions grows
rather large.

**m**\ [*lon0[/lat0]*]\ */scale* or **M**\ [*lon0*][*/lat0*]\ */width*
**m**\ [*lon0*/\ [*lat0*/]]\ *scale* or **M**\ [*lon0*/\ [*lat0*/]]\ *width*

The projection is set with **m** or **M**. The central meridian is set with the
optional *lon0* and the standard parallel is set with the optional *lat0*.
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/cyl/cyl_stereographic.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
cylinder crosses the sphere at two standard parallels, equidistant from the
equator.

**cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *scale*
or **Cyl_stere/**\ [*lon0/*]\ [*lat0/*]\ *width*
**cyl_stere**/\ [*lon0*/\ [*lat0*/]]\ *scale* or
**Cyl_stere**/\ [*lon0*/\ [*lat0*/]]\ *width*

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
Expand Down
2 changes: 1 addition & 1 deletion examples/projections/cyl/cyl_transverse_mercator.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
the center, and equator are straight lines; other parallels and meridians are
complex curves.

**t**\ *lon0/*\ [*lat0/*\ ]\ *scale* or **T**\ *lon0/*\ [*lat0/*\ ]\ *width*
**t**\ *lon0*\ [/\ *lat0*]/\ *scale* or **T**\ *lon0*\ [/\ *lat0*]/\ *width*

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
Expand Down
16 changes: 8 additions & 8 deletions examples/projections/table/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The below table shows the projection codes for the 31 GMT projections.
- :doc:`Albers conic equal area </projections/conic/conic_albers>`
* - **C**\ |lon0|/|lat0|/\ *width*
- :doc:`Cassini cylindrical </projections/cyl/cyl_cassini>`
* - **Cyl_stere/**\ [|lon0|\ [/|lat0|/]]\ *width*
* - **Cyl_stere**/\ [|lon0|/\ [|lat0|/]]\ *width*
- :doc:`Cylindrical stereographic </projections/cyl/cyl_stereographic>`
* - **D**\ |lon0|/|lat0|/|lat1|/|lat2|/\ *width*
- :doc:`Equidistant conic </projections/conic/conic_equidistant>`
Expand All @@ -34,8 +34,8 @@ The below table shows the projection codes for the 31 GMT projections.
- :doc:`Azimuthal gnomonic </projections/azim/azim_gnomonic>`
* - **G**\ |lon0|/|lat0|\ [/\ *horizon*]/\ *width*
- :doc:`Azimuthal orthographic </projections/azim/azim_orthographic>`
* - **G**\ |lon0|/|lat0|\ */width*\[**+a**\ *azimuth*]\ [**+t**\ *tilt*]\
[**+v**\ *vwidth/vheight*]\ [**+w**\ *twist*]\ [**+z**\ *altitude*]
* - **G**\ |lon0|/|lat0|/\ *width*\ [**+a**\ *azimuth*]\ [**+t**\ *tilt*]\
[**+v**\ *vwidth*/*vheight*]\ [**+w**\ *twist*]\ [**+z**\ *altitude*]
- :doc:`General perspective </projections/azim/azim_general_perspective>`
* - **H**\ [|lon0|/]\ *width*
- :doc:`Hammer equal area </projections/misc/misc_hammer>`
Expand All @@ -49,11 +49,11 @@ The below table shows the projection codes for the 31 GMT projections.
- :doc:`Eckert VI equal area </projections/misc/misc_eckertVI>`
* - **L**\ |lon0|/|lat0|/|lat1|/|lat2|/\ *width*
- :doc:`Lambert conic conformal </projections/conic/conic_lambert>`
* - **M**\ [|lon0|\ [/|lat0|]/]\ *width*
* - **M**\ [|lon0|/\ [|lat0|/]]\ *width*
- :doc:`Mercator cylindrical </projections/cyl/cyl_mercator>`
* - **N**\ [|lon0|/]\ *width*
- :doc:`Robinson </projections/misc/misc_robinson>`
* - **Oa**\ |lon0|/|lat0|/\ *azim*/*width*\ [**+v**]
* - **Oa**\ |lon0|/|lat0|/\ *azimuth*/*width*\ [**+v**]
- :doc:`Oblique Mercator, 1: origin and azimuth </projections/cyl/cyl_oblique_mercator_1>`
* - **Ob**\ |lon0|/|lat0|/|lon1|/|lat1|/\ *width*\ [**+v**]
- :doc:`Oblique Mercator, 2: two points </projections/cyl/cyl_oblique_mercator_2>`
Expand All @@ -63,16 +63,16 @@ The below table shows the projection codes for the 31 GMT projections.
[**+r**\ *offset*][**+t**\ *origin*][**+z**\ [**p**\|\ *radius*]]
- :doc:`Polar </projections/nongeo/polar>` [azimuthal]
(:math:`\theta, r`) (or cylindrical)
* - **Poly**\ [|lon0|\ [/|lat0|]/]\ *width*
* - **Poly**/\ [|lon0|/\ [|lat0|/]]\ *width*
- :doc:`Polyconic </projections/conic/polyconic>`
* - **Q**\ [|lon0|\ [/|lat0|/]]\ *width*
* - **Q**\ [|lon0|/\ [|lat0|/]]\ *width*
- :doc:`Equidistant cylindrical </projections/cyl/cyl_equidistant>`
* - **R**\ [|lon0|/]\ *width*
- :doc:`Winkel Tripel </projections/misc/misc_winkel_tripel>`
* - **S**\ |lon0|/|lat0|\ [/\ *horizon*]/\ *width*
- :doc:`General stereographic
</projections/azim/azim_general_stereographic>`
* - **T**\ [|lon0|\ [/|lat0|]/]\ *width*
* - **T**\ |lon0|\ [/\ |lat0|]/\ *width*
- :doc:`Transverse Mercator </projections/cyl/cyl_transverse_mercator>`
* - **U**\ *zone*/*width*
- :doc:`Universal Transverse Mercator (UTM)
Expand Down