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.

Sign up for GitHub

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

Jump to bottom

Add tutorial to explain naming of PyGMT figure elements #2383

Merged
merged 38 commits into from
Sep 1, 2023
Merged

Add tutorial to explain naming of PyGMT figure elements #2383

merged 38 commits into from
Sep 1, 2023

Conversation

jhtong33
Copy link
Contributor

@jhtong33 jhtong33 commented Feb 25, 2023 •
edited by weiji14
Loading

Description of proposed changes
Add a tutorial to explain naming of figure elements in a PyGMT
image

Preview: https://pygmt-dev--2383.org.readthedocs.build/en/2383/get_started/03_figure_element.html

Fixes #2026

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

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

@jhtong33
Copy link
Contributor Author

/format

@seisman seisman added the documentation Improvements or additions to documentation label Feb 26, 2023
@seisman seisman added this to the 0.9.0 milestone Feb 26, 2023
@jhtong33
Copy link
Contributor Author

/format

@jhtong33 jhtong33 self-assigned this Mar 16, 2023
@yvonnefroehlich yvonnefroehlich mentioned this pull request Mar 17, 2023
Open
3 tasks
yvonnefroehlich
yvonnefroehlich reviewed Mar 19, 2023
View reviewed changes
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
@seisman seisman modified the milestones: 0.9.0, 0.10.0 Mar 19, 2023
@jhtong33 jhtong33 marked this pull request as ready for review March 20, 2023 02:58
@michaelgrund michaelgrund changed the title Add a tutorial to explain naming of figure elements in a PyGMT Add a tutorial to explain naming of PyGMT figure elements Aug 25, 2023
@jhtong33
Copy link
Contributor Author

jhtong33 commented Aug 28, 2023 •
edited
Loading

@weiji14 @michaelgrund @yvonnefroehlich

Sorry for the slow response, I think the example almost done. I will try to review the comment as soon as possible.

@jhtong33
Copy link
Contributor Author

/format

@jhtong33 @yvonnefroehlich
Apply suggestions from code review
29944e9 
Co-authored-by: Yvonne Fröhlich <[email protected]>
@jhtong33 jhtong33 added the final review call This PR requires final review and approval from a second reviewer label Aug 30, 2023
@weiji14 weiji14 removed the needs review This PR has higher priority and needs review. label Aug 30, 2023
weiji14
weiji14 approved these changes Aug 30, 2023
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Thanks @JingHuiTong! We'll merge this after a second approval, and get it in for PyGMT v0.10.0 😄

michaelgrund
michaelgrund reviewed Aug 31, 2023
View reviewed changes
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

Some small adjustments to have an almost consistent style regarding the distances between different text boxes.

examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
yvonnefroehlich
yvonnefroehlich reviewed Aug 31, 2023
View reviewed changes
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
@jhtong33 @yvonnefroehlich
Apply suggestions from code review
3b84a1a 
Co-authored-by: Yvonne Fröhlich <[email protected]>
yvonnefroehlich
yvonnefroehlich reviewed Aug 31, 2023
View reviewed changes
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.

Thanks @JingHuiTong for working on this tutorial 🙂. It will definitely help users coming from other python plotting libraries or MATLAB.

examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
examples/get_started/03_figure_element.py Outdated Show resolved Hide resolved
@weiji14
Copy link
Member

weiji14 commented Sep 1, 2023

I'm gonna go ahead and apply Yvonne's suggestions and merge this PR for PyGMT v0.10.0.

@weiji14 @yvonnefroehlich
Apply suggestions from code review
f3e3bac 
Co-authored-by: Yvonne Fröhlich <[email protected]>
@weiji14 weiji14 enabled auto-merge (squash) September 1, 2023 03:09
@weiji14 weiji14 changed the title Add a tutorial to explain naming of PyGMT figure elements Add tutorial to explain naming of PyGMT figure elements Sep 1, 2023
@weiji14 weiji14 mentioned this pull request Sep 1, 2023
Merged
15 tasks
@seisman seisman merged commit a63af1b into GenericMappingTools:main Sep 1, 2023
6 checks passed
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yvonnefroehlich yvonnefroehlich yvonnefroehlich left review comments

@seisman seisman seisman approved these changes

@michaelgrund michaelgrund michaelgrund approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

@jhtong33 jhtong33

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.10.0
Development

Successfully merging this pull request may close these issues.

Explain the naming of figure elements in a PyGMT figure
7 participants
@jhtong33 @willschlitzer @weiji14 @seisman @michaelgrund @yvonnefroehlich @actions-bot