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 individual custom symbols #1348

Merged
merged 9 commits into from
Jun 26, 2021

Conversation

michaelgrund
Copy link
Member

Description of proposed changes

So far we have no gallery example in which custom symbols are shown. This PR adds such an example to the gallery. Since the number of custom symbols coming with GMT is huge (https://docs.generic-mapping-tools.org/latest/cookbook/custom-symbols.html) I think we should focus only on a subset of them.

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 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

So far we have no gallery example in which custom symbols are shown. This PR adds such an example to the gallery. Since the number of custom symbols coming with GMT is huge (https://docs.generic-mapping-tools.org/latest/cookbook/custom-symbols.html) I think we should focus only on a subset of them.
@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Jun 22, 2021
@michaelgrund michaelgrund added this to the 0.5.0 milestone Jun 22, 2021
@michaelgrund michaelgrund self-assigned this Jun 22, 2021
@michaelgrund michaelgrund marked this pull request as draft June 22, 2021 17:26
@willschlitzer
Copy link
Contributor

Looks good so far; I think this is a useful gallery example.

@michaelgrund michaelgrund changed the title WIP: Add a gallery example showing individual custom symbols Add a gallery example showing individual custom symbols Jun 24, 2021
@michaelgrund michaelgrund marked this pull request as ready for review June 24, 2021 15:45
Copy link
Member

@core-man core-man left a comment

Choose a reason for hiding this comment

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

All are great except for one minor comment above.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jun 25, 2021
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 26, 2021
@seisman seisman merged commit 8a9f622 into master Jun 26, 2021
@seisman seisman deleted the gallery-custom-syms branch June 26, 2021 20:52
@seisman seisman modified the milestones: 0.5.0, 0.4.1 Jul 25, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants