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: Add basic tutorial "Plotting polygons" #3593

Merged
merged 24 commits into from
Nov 26, 2024
Merged

DOC: Add basic tutorial "Plotting polygons" #3593

merged 24 commits into from
Nov 26, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 6, 2024

Description of proposed changes

Add a basic tutorial for plotting polygons, explaining the pen, fill, and close parameters.

Related basic tutorials:

Fixes #3591

Preview: https://pygmt-dev--3593.org.readthedocs.build/en/3593/tutorials/basics/polygons.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 enhancement Improving an existing feature labels Nov 6, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 6, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Nov 6, 2024
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add basic tutorial "Plotting polygons" DOC: Add basic tutorial "Plotting polygons" Nov 13, 2024
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Nov 13, 2024
@seisman
Copy link
Member

seisman commented Nov 14, 2024

A little off-topic: what do you think about updating the existing "Plotting lines" tutorial to make it more eye-catching? Currently, the tutorial just plots lines with two or more data points. I feel a more complicated line/curve like sine/cosine functions are better.

examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
examples/tutorials/basics/polygons.py Outdated Show resolved Hide resolved
yvonnefroehlich and others added 3 commits November 18, 2024 07:23
@yvonnefroehlich
Copy link
Member Author

A little off-topic: what do you think about updating the existing "Plotting lines" tutorial to make it more eye-catching? Currently, the tutorial just plots lines with two or more data points. I feel a more complicated line/curve like sine/cosine functions are better.

Will look and work on this after AGU.

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed enhancement Improving an existing feature needs review This PR has higher priority and needs review. labels Nov 25, 2024
@seisman seisman merged commit 56541e8 into main Nov 26, 2024
10 checks passed
@seisman seisman deleted the add-tut-polygons branch November 26, 2024 01:48
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Nov 26, 2024
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 16, 2024
49 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a tutorial for plotting polygons
2 participants