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

Add a gallery example showing the usage of Figure.hlines and Figure.vlines #3755

Merged
merged 44 commits into from
Jan 16, 2025

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Jan 8, 2025

Description of proposed changes

This PR adds a gallery example to show how the Figure.hlines and Figure.vlines methods can be used.

Related to #923 and #3726

Preview: https://pygmt-dev--3755.org.readthedocs.build/en/3755/gallery/lines/hlines_vlines.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.

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

@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Jan 8, 2025
@michaelgrund michaelgrund added this to the 0.15.0 milestone Jan 8, 2025
@michaelgrund michaelgrund changed the title WIP: Add a gallery example showing the usage of Fig.hlines and Fig.vlines WIP: Add a gallery example showing the usage of Figure.hlines and Figure.vlines Jan 8, 2025
@michaelgrund
Copy link
Member Author

/format

@michaelgrund
Copy link
Member Author

/format

@michaelgrund michaelgrund changed the title WIP: Add a gallery example showing the usage of Figure.hlines and Figure.vlines Add a gallery example showing the usage of Figure.hlines and Figure.vlines Jan 8, 2025
@michaelgrund michaelgrund added the needs review This PR has higher priority and needs review. label Jan 8, 2025
@michaelgrund
Copy link
Member Author

/format

@seisman
Copy link
Member

seisman commented Jan 10, 2025

Please ignore the failing "Style Checks", which will be addressed in #3763.

examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
pygmt/src/hlines.py Outdated Show resolved Hide resolved
pygmt/src/hlines.py Outdated Show resolved Hide resolved
pygmt/src/hlines.py Outdated Show resolved Hide resolved
pygmt/src/vlines.py Outdated Show resolved Hide resolved
pygmt/src/vlines.py Outdated Show resolved Hide resolved
michaelgrund and others added 2 commits January 10, 2025 12:06
@seisman
Copy link
Member

seisman commented Jan 10, 2025

@michaelgrund Thanks for making the gallery example! I feel it's already in great shape!

My last comment is about the figure title. Currently we use hlines/vlines Cartesian/polar/geographic. Maybe Cartesian/Polar/Geographic hlines/vlines are better?

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jan 10, 2025
pygmt/src/vlines.py Outdated Show resolved Hide resolved
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
michaelgrund and others added 2 commits January 12, 2025 15:39
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
pygmt/src/hlines.py Outdated Show resolved Hide resolved
pygmt/src/vlines.py Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
examples/gallery/lines/hlines_vlines.py Outdated Show resolved Hide resolved
pygmt/src/hlines.py Outdated Show resolved Hide resolved
pygmt/src/vlines.py Outdated Show resolved Hide resolved
michaelgrund and others added 2 commits January 13, 2025 09:38
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

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

Besides my comment regarding mentioning the “Line style” Gallery example, I think this Gallery examples look nice 🙂! Thanks @michaelgrund for your patience with all the formulations updates.

michaelgrund and others added 2 commits January 14, 2025 11:19
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman merged commit 199ef2b into main Jan 16, 2025
20 of 21 checks passed
@seisman seisman deleted the gallery-hlines-vlines branch January 16, 2025 10:14
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 16, 2025
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.

4 participants