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

DOC: Mention datetime tutorial in Cartesian linear projection #3473

Merged
merged 4 commits into from
Sep 30, 2024

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

Besides referring to the upstream GMT documentation, it makes sense to mention the PyGMT tutorial regarding how date time input data and format can be visualized in PyGMT.

Also adjust the line length to 81 characters.

Preview:

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 30, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Sep 30, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Sep 30, 2024
: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.

@seisman seisman merged commit 2a6ff6a into main Sep 30, 2024
10 checks passed
@seisman seisman deleted the mention-date-tut-cart branch September 30, 2024 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants