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 gallery example showing how to build an envelope around a curve #2587

Merged
merged 43 commits into from
Jul 24, 2023
Merged

Add gallery example showing how to build an envelope around a curve #2587

merged 43 commits into from
Jul 24, 2023

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jun 27, 2023 •
edited
Loading

Description of proposed changes

This PR aims to add a gallery example showing how to build an envelope around a curve via the close parameter of pygmt.Figure.plot.

Upstream GMT documentation: https://docs.generic-mapping-tools.org/dev/plot.html#l

Preview: https://pygmt-dev--2587.org.readthedocs.build/en/2587/gallery/lines/envelope.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 commands are:

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

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Jun 27, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone Jun 27, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Jun 27, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft June 27, 2023 20:03
@yvonnefroehlich yvonnefroehlich changed the title Add gallery example showing how to build an envelope around a curve WIP: Add gallery example showing how to build an envelope around a curve Jun 27, 2023
@yvonnefroehlich
Copy link
Member Author

/format

michaelgrund
michaelgrund reviewed Jun 28, 2023
View reviewed changes
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title WIP: Add gallery example showing how to build an envelope around a curve Add gallery example showing how to build an envelope around a curve Jul 10, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review July 10, 2023 15:43
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Jul 11, 2023
seisman
seisman reviewed Jul 20, 2023
View reviewed changes
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
yvonnefroehlich and others added 3 commits July 20, 2023 15:05
@yvonnefroehlich @seisman
Write in a single line to reduce number of lines
d772edb 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich @seisman
Write in a single line to reduce number of lines
dfca09a 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich @seisman
Write in a single line to reduce number of lines
a276425 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
seisman
seisman approved these changes Jul 20, 2023
View reviewed changes
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 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 Jul 20, 2023
michaelgrund
michaelgrund approved these changes Jul 24, 2023
View reviewed changes
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
examples/gallery/lines/envelope.py Outdated Show resolved Hide resolved
yvonnefroehlich and others added 3 commits July 24, 2023 10:01
@yvonnefroehlich @michaelgrund
Use hyphen (code review)
3d89b8e 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@yvonnefroehlich @michaelgrund
Use hyphen (code review)
d6b127e 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@yvonnefroehlich @michaelgrund
Remove word (code review)
e42b388 
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman merged commit d0ca06a into main Jul 24, 2023
@seisman seisman deleted the add-gallery-envelope branch July 24, 2023 09:06
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelgrund michaelgrund michaelgrund approved these changes

@seisman seisman seisman approved these changes

Assignees

@yvonnefroehlich yvonnefroehlich

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

Successfully merging this pull request may close these issues.
4 participants
@yvonnefroehlich @seisman @michaelgrund @actions-bot