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 gallery example showing usage of project #1696

Merged
merged 10 commits into from
Jan 13, 2022
Merged

Add gallery example showing usage of project #1696

merged 10 commits into from
Jan 13, 2022

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Jan 7, 2022

Description of proposed changes

Although we plan to add inline examples for some of the processing function, I think for project it's easy to show the usage with a very simple example.

Addresses #1666.

Preview:

Great circles

Fixes #

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

@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Jan 7, 2022
@michaelgrund michaelgrund added this to the 0.6.0 milestone Jan 7, 2022
@michaelgrund michaelgrund marked this pull request as draft January 7, 2022 17:09
@michaelgrund michaelgrund marked this pull request as ready for review January 7, 2022 17:21
examples/gallery/lines/great_circles.py Outdated Show resolved Hide resolved
examples/gallery/lines/great_circles.py Outdated Show resolved Hide resolved
examples/gallery/lines/great_circles.py Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
examples/gallery/lines/great_circles.py Outdated Show resolved Hide resolved
examples/gallery/lines/great_circles.py Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jan 11, 2022
@weiji14 weiji14 changed the title Create gallery example showing the usage of project Add gallery example showing usage of project Jan 13, 2022
@weiji14 weiji14 enabled auto-merge (squash) January 13, 2022 01:14
@weiji14 weiji14 disabled auto-merge January 13, 2022 01:15
@weiji14 weiji14 merged commit 77aaa7a into main Jan 13, 2022
@weiji14 weiji14 deleted the gallery-project branch January 13, 2022 01:15
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Jan 13, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* Create gallery example showing the usage of project

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
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.

3 participants