Skip to content

DOC/tutorial "Plotting lines": General improvements #3587

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

Merged
merged 5 commits into from
Nov 6, 2024
Merged

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 5, 2024

Description of proposed changes

This PR improves the tutorial "Plotting lines":

  • Add missing words
  • Improve formulations, add comments within the code examples
  • Rewrap the line length
  • Split setting up the Cartesian plot (Figure.basemap) and plotting of the line(s) (Figure.plot); I personally feel this is clearer to understand, but I am open to other opinions on this change
  • Do not use the pen parameter (change the pen attributes) in the first section, as this parameter will be explained in detail in the second section

Preview: https://pygmt-dev--3587.org.readthedocs.build/en/3587/tutorials/basics/lines.html

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 Nov 5, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 5, 2024
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Nov 6, 2024
yvonnefroehlich and others added 2 commits November 6, 2024 08:44
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Nov 6, 2024
@seisman seisman merged commit 4498f71 into main Nov 6, 2024
9 of 10 checks passed
@seisman seisman deleted the improve-tut-line branch November 6, 2024 07:56
seisman added a commit that referenced this pull request Nov 18, 2024
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
seisman added a commit that referenced this pull request Nov 18, 2024
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
seisman added a commit that referenced this pull request Nov 19, 2024
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
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.

3 participants