From 0b6b0eba882c478ffeeaecad5bfc7fdf657f5d76 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 22:15:34 +0200 Subject: [PATCH 01/11] Fix typo in general syntax --- examples/projections/nongeo/cartesian_linear.py | 2 +- examples/projections/nongeo/cartesian_logarithmic.py | 2 +- examples/projections/nongeo/cartesian_power.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 1c4e73ec36e..9325259863f 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -2,7 +2,7 @@ Cartesian linear ================ -**X**\ *width*/[*height*]: Give the *width* of the figure and the optional +**X**\ *width*[/*height*]: Give the *width* of the figure and the optional *height*. """ import pygmt diff --git a/examples/projections/nongeo/cartesian_logarithmic.py b/examples/projections/nongeo/cartesian_logarithmic.py index e6e5c8c95a8..d0f3f69849a 100644 --- a/examples/projections/nongeo/cartesian_logarithmic.py +++ b/examples/projections/nongeo/cartesian_logarithmic.py @@ -2,7 +2,7 @@ Cartesian logarithmic ===================== -**X**\ *width*\ [**l**]/[*height*\ [**l**]]: Give the *width* of the figure and +**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. """ diff --git a/examples/projections/nongeo/cartesian_power.py b/examples/projections/nongeo/cartesian_power.py index a4425416b41..9730e74677c 100644 --- a/examples/projections/nongeo/cartesian_power.py +++ b/examples/projections/nongeo/cartesian_power.py @@ -2,7 +2,7 @@ Cartesian power =============== -**X**\ *width*\ [**p**\ *pvalue*]/[*height*\ [**p**\ *pvalue*]]: Give the +**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. From c6017736f52ea164867251951e3a84b7d2019c83 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 22:21:12 +0200 Subject: [PATCH 02/11] Add general syntax for 'scale' option in 'cartesian_linear.py' --- examples/projections/nongeo/cartesian_linear.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 9325259863f..071a7569e93 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -2,8 +2,9 @@ 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*. """ import pygmt From de39ac67c019443c9ab41368ed8039990e08d55e Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 22:23:19 +0200 Subject: [PATCH 03/11] Add general syntax for 'scale' option in 'cartesian_logarithmic.py' --- examples/projections/nongeo/cartesian_logarithmic.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/examples/projections/nongeo/cartesian_logarithmic.py b/examples/projections/nongeo/cartesian_logarithmic.py index d0f3f69849a..b3d0f9edc27 100644 --- a/examples/projections/nongeo/cartesian_logarithmic.py +++ b/examples/projections/nongeo/cartesian_logarithmic.py @@ -2,9 +2,12 @@ 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*. +Each axis with a logarithmic transformation requires **l** after +its size argument. """ import numpy as np import pygmt From 0bb30b51dee12abccb02a79908da704086aeb284 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 22:24:38 +0200 Subject: [PATCH 04/11] Add general syntax for 'scale' option in 'cartesian_power.py' --- examples/projections/nongeo/cartesian_power.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/examples/projections/nongeo/cartesian_power.py b/examples/projections/nongeo/cartesian_power.py index 9730e74677c..559e48747f2 100644 --- a/examples/projections/nongeo/cartesian_power.py +++ b/examples/projections/nongeo/cartesian_power.py @@ -2,10 +2,12 @@ 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*. +Each axis with a power transformation requires **p** and the exponent +for that axis after its size argument. """ import numpy as np import pygmt From cffcf5b64b2c40d7605ca5d93a2145916e21117e Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 22:28:11 +0200 Subject: [PATCH 05/11] Add docstring for 'scale' option --- examples/projections/nongeo/cartesian_linear.py | 2 ++ examples/projections/nongeo/cartesian_logarithmic.py | 2 ++ examples/projections/nongeo/cartesian_power.py | 2 ++ 3 files changed, 6 insertions(+) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 071a7569e93..3eec38fb729 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -5,6 +5,8 @@ **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 diff --git a/examples/projections/nongeo/cartesian_logarithmic.py b/examples/projections/nongeo/cartesian_logarithmic.py index b3d0f9edc27..d542b05dbd3 100644 --- a/examples/projections/nongeo/cartesian_logarithmic.py +++ b/examples/projections/nongeo/cartesian_logarithmic.py @@ -6,6 +6,8 @@ **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. """ diff --git a/examples/projections/nongeo/cartesian_power.py b/examples/projections/nongeo/cartesian_power.py index 559e48747f2..7a1179a55cc 100644 --- a/examples/projections/nongeo/cartesian_power.py +++ b/examples/projections/nongeo/cartesian_power.py @@ -6,6 +6,8 @@ **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. """ From ea5a13e2243449e0131368a2424c01b112ce99d7 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Fri, 25 Aug 2023 23:00:41 +0200 Subject: [PATCH 06/11] Fix general syntax for in 'cartesian_linear.py' --- examples/projections/nongeo/cartesian_linear.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 3eec38fb729..af4e4293003 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -2,7 +2,7 @@ Cartesian linear ================ -**X**\ *width*[/*height*] or **x**\ *x-scale*[/*y-scale*] +**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 From 943ad7fe6f80db3e2bdb320d0f1d46c12802a29c Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sun, 27 Aug 2023 10:37:54 +0200 Subject: [PATCH 07/11] Mention geo and calender coordinates usage with linear projection --- examples/projections/nongeo/cartesian_linear.py | 10 +++++++++- examples/projections/nongeo/cartesian_logarithmic.py | 2 +- examples/projections/nongeo/cartesian_power.py | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index af4e4293003..6c22611c5a3 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -6,7 +6,15 @@ 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*. +an *x-scale* and an optional *y-scale*. + +The Cartesian linear projection is primarily designed for regular +floating point data. To plot geographical data in a linear +projection, please see the upstream GMT docuemntation at +https://docs.generic-mapping-tools.org/dev/cookbook/coordinate-transformations.html#geographic-coordinates +To make the linear plot using calendar date/time as the input +coordinates, please see the GMT docuemntation at +https://docs.generic-mapping-tools.org/dev/cookbook/coordinate-transformations.html#calendar-time-coordinates """ import pygmt diff --git a/examples/projections/nongeo/cartesian_logarithmic.py b/examples/projections/nongeo/cartesian_logarithmic.py index d542b05dbd3..d33f7b5e0ca 100644 --- a/examples/projections/nongeo/cartesian_logarithmic.py +++ b/examples/projections/nongeo/cartesian_logarithmic.py @@ -7,7 +7,7 @@ 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*. +an *x-scale* and an optional *y-scale*. Each axis with a logarithmic transformation requires **l** after its size argument. """ diff --git a/examples/projections/nongeo/cartesian_power.py b/examples/projections/nongeo/cartesian_power.py index 7a1179a55cc..4abfd0bec0f 100644 --- a/examples/projections/nongeo/cartesian_power.py +++ b/examples/projections/nongeo/cartesian_power.py @@ -7,7 +7,7 @@ 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*. +an *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. """ From 3a60b02d7e553914f2c2c5a17851f4d72e941d12 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sun, 27 Aug 2023 11:06:37 +0200 Subject: [PATCH 08/11] Try to use GMT docs link --- examples/projections/nongeo/cartesian_linear.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 6c22611c5a3..fc664e0f213 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -10,11 +10,11 @@ The Cartesian linear projection is primarily designed for regular floating point data. To plot geographical data in a linear -projection, please see the upstream GMT docuemntation at -https://docs.generic-mapping-tools.org/dev/cookbook/coordinate-transformations.html#geographic-coordinates +projection, see the upstream GMT documentation +:gmt-docs:`Geographic coordinates `. To make the linear plot using calendar date/time as the input -coordinates, please see the GMT docuemntation at -https://docs.generic-mapping-tools.org/dev/cookbook/coordinate-transformations.html#calendar-time-coordinates +coordinates, see the GMT documentation +:gmt-docs:`Calendar time coordinates `. """ import pygmt From af43f5d79d75776ef5a8c7e423d8d688c7351c41 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sun, 27 Aug 2023 11:36:00 +0200 Subject: [PATCH 09/11] Allow for longer line --- examples/projections/nongeo/cartesian_linear.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index fc664e0f213..1134ea0baa4 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -11,10 +11,10 @@ The Cartesian linear projection is primarily designed for regular floating point data. To plot geographical data in a linear projection, see the upstream GMT documentation -:gmt-docs:`Geographic coordinates `. +:gmt-docs:`Geographic coordinates `. # noqa:W505 To make the linear plot using calendar date/time as the input coordinates, see the GMT documentation -:gmt-docs:`Calendar time coordinates `. +:gmt-docs:`Calendar time coordinates `. # noqa:W505 """ import pygmt From 710af3fb541283a0ae1454b5a495aa5f4554f616 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sun, 27 Aug 2023 11:49:52 +0200 Subject: [PATCH 10/11] Try fixing line length via line break --- examples/projections/nongeo/cartesian_linear.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index 1134ea0baa4..fb65f2b2fdf 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -11,10 +11,12 @@ The Cartesian linear projection is primarily designed for regular floating point data. To plot geographical data in a linear projection, see the upstream GMT documentation -:gmt-docs:`Geographic coordinates `. # noqa:W505 +:gmt-docs:`Geographic coordinates +`. To make the linear plot using calendar date/time as the input coordinates, see the GMT documentation -:gmt-docs:`Calendar time coordinates `. # noqa:W505 +:gmt-docs:`Calendar time coordinates +`. """ import pygmt From 9988d718b69f2ae626d6511b4b6ad2765d389fb0 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sun, 27 Aug 2023 12:07:57 +0200 Subject: [PATCH 11/11] Remove un-needed word --- examples/projections/nongeo/cartesian_linear.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/projections/nongeo/cartesian_linear.py b/examples/projections/nongeo/cartesian_linear.py index fb65f2b2fdf..fc3872319ad 100644 --- a/examples/projections/nongeo/cartesian_linear.py +++ b/examples/projections/nongeo/cartesian_linear.py @@ -13,7 +13,7 @@ projection, see the upstream GMT documentation :gmt-docs:`Geographic coordinates `. -To make the linear plot using calendar date/time as the input +To make the linear plot using calendar date/time as input coordinates, see the GMT documentation :gmt-docs:`Calendar time coordinates `.