Skip to content

Expand documentation for Cartesian projections #2643

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.

Sign up for GitHub

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

Merged
weiji14 merged 12 commits into from
Aug 28, 2023
Merged

Expand documentation for Cartesian projections #2643

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0b6b0eb
Fix typo in general syntax
yvonnefroehlich Aug 25, 2023
c601773
Add general syntax for 'scale' option in 'cartesian_linear.py'
yvonnefroehlich Aug 25, 2023
de39ac6
Add general syntax for 'scale' option in 'cartesian_logarithmic.py'
yvonnefroehlich Aug 25, 2023
0bb30b5
Add general syntax for 'scale' option in 'cartesian_power.py'
yvonnefroehlich Aug 25, 2023
cffcf5b
Add docstring for 'scale' option
yvonnefroehlich Aug 25, 2023
ea5a13e
Fix general syntax for in 'cartesian_linear.py'
yvonnefroehlich Aug 25, 2023
1174a47
Merge branch 'main' into improve-docs-projection-linear
yvonnefroehlich Aug 27, 2023
943ad7f
Mention geo and calender coordinates usage with linear projection
yvonnefroehlich Aug 27, 2023
3a60b02
Try to use GMT docs link
yvonnefroehlich Aug 27, 2023
af43f5d
Allow for longer line
yvonnefroehlich Aug 27, 2023
710af3f
Try fixing line length via line break
yvonnefroehlich Aug 27, 2023
9988d71
Remove un-needed word
yvonnefroehlich Aug 27, 2023
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
7 changes: 5 additions & 2 deletions examples/projections/nongeo/cartesian_linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
Cartesian linear
================
**X**\ *width*/[*height*]: Give the *width* of the figure and the optional
*height*.
**X**\ *width*\ [/*height*] or **x**\ *x-scale*\ [/*y-scale*]
Give the *width* of the figure and the optional *height*.
The lower-case version **x** is similar to **X** but expects
a *x-scale* and an optional *y-scale*.
"""
import pygmt

Expand Down
11 changes: 8 additions & 3 deletions examples/projections/nongeo/cartesian_logarithmic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
Cartesian logarithmic
=====================
**X**\ *width*\ [**l**]/[*height*\ [**l**]]: Give the *width* of the figure and
the optional *height*. Each axis with a logarithmic transformation
requires **l** after its size argument.
**X**\ *width*\ [**l**][/*height*\ [**l**]] or
**x**\ *x-scale*\ [**l**][/*y-scale*\ [**l**]]
Give the *width* of the figure and the optional *height*.
The lower-case version **x** is similar to **X** but expects
a *x-scale* and an optional *y-scale*.
Each axis with a logarithmic transformation requires **l** after
its size argument.
"""
import numpy as np
import pygmt
Expand Down
12 changes: 8 additions & 4 deletions examples/projections/nongeo/cartesian_power.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
Cartesian power
===============
**X**\ *width*\ [**p**\ *pvalue*]/[*height*\ [**p**\ *pvalue*]]: Give the
*width* of the figure and the optional argument *height*. Each axis with
a power transformation requires **p** and the exponent for that axis
after its size argument.
**X**\ *width*\ [**p**\ *pvalue*][/*height*\ [**p**\ *pvalue*]] or
**x**\ *x-scale*\ [**p**\ *pvalue*][/*y-scale*\ [**p**\ *pvalue*]]
Give the *width* of the figure and the optional argument *height*.
The lower-case version **x** is similar to **X** but expects
a *x-scale* and an optional *y-scale*.
Each axis with a power transformation requires **p** and the exponent
for that axis after its size argument.
"""
import numpy as np
import pygmt
Expand Down