Skip to content

Improve example for Polar projection #2110

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 19 commits into from
Oct 30, 2022
Merged

Improve example for Polar projection #2110

merged 19 commits into from
Oct 30, 2022

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

Correspoinding to #2058 (review) and #2058 (comment) this PR aims to improve the example for the Polar projection.

  • Add description of single plots (instead of #--------------)
  • Set titles via -t modifier of frame parameter (instead of pygmt.Figure.text method)

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 commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@yvonnefroehlich
Copy link
Member Author

/format

@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 4, 2022
@seisman seisman added this to the 0.8.0 milestone Sep 4, 2022
@willschlitzer willschlitzer modified the milestones: 0.8.0, 1.0.0 Sep 8, 2022
@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Sep 14, 2022

I added noqa:W605 to allow for the escape sequence \z within the title (see b9e2d8d). But I feel this is not an optimal solution, as users might be confused by seeing this as an comment in the example code.

@seisman
Copy link
Member

seisman commented Oct 28, 2022

I think this PR is in great and "WIP" can be removed from the title. @yvonnefroehlich What do you think?

@yvonnefroehlich
Copy link
Member Author

I think this PR is in great and "WIP" can be removed from the title. @yvonnefroehlich What do you think?

I am not totally sure. I understand the comment by @maxrjones in the way that descriptive titles should be added for the single subplots. Until now, I only wrote the positions. But maybe these are enough, as there are already quite detailed comments and titles would at least partly repeat the comments?

@yvonnefroehlich yvonnefroehlich changed the title WIP: Improve example for Polar projection Improve example for Polar projection Oct 28, 2022
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Oct 29, 2022
@seisman seisman merged commit 8fa1a97 into main Oct 30, 2022
@seisman seisman deleted the improve-polar-proj-example branch October 30, 2022 15:46
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 30, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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.

4 participants