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.

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

Jump to bottom

DOC: Mention datetime tutorial in Cartesian linear projection #3473

Merged
merged 4 commits into from
Sep 30, 2024
Merged

DOC: Mention datetime tutorial in Cartesian linear projection #3473

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
346777e
Mention datetime tutorial
yvonnefroehlich Sep 30, 2024
864579e
Write link to GMT docs in one line
yvonnefroehlich Sep 30, 2024
a5e2268
Merge branch 'main' into mention-date-tut-cart
yvonnefroehlich Sep 30, 2024
7de29df
Revert "Write link to GMT docs in one line"
yvonnefroehlich Sep 30, 2024
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
18 changes: 8 additions & 10 deletions examples/projections/nongeo/cartesian_linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,16 @@

**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
an *x-scale* and an optional *y-scale*.
Give the *width* of the figure and the optional *height*. The lower-case version
**x** is similar to **X** but expects 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, see the upstream GMT documentation
:gmt-docs:`Geographic coordinates
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
<reference/coordinate-transformations.html#geographic-coordinates>`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to write the gmt-docs role in one line, like:

:gmt-docs:`Geographic coordinates <reference/coordinate-transformations.html#geographic-coordinates>`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. I just tried this in commit 864579e, but the style checks fail (locally and on GitHub) because of the too long line.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. please revert the changes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in commit 7de29df.

To make the linear plot using calendar date/time as input
coordinates, see the GMT documentation
:gmt-docs:`Calendar time coordinates
To make the linear plot using calendar date/time as input coordinates, see the
tutorial :doc:`Plotting datetime charts </tutorials/advanced/date_time_charts>`.
GMT documentation :gmt-docs:`Calendar time coordinates
<reference/coordinate-transformations.html#calendar-time-coordinates>`.
"""

Expand Down