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

Gallery example "Custom symbols": Mention own custom symbols #3186

Merged
merged 5 commits into from
Apr 21, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Apr 21, 2024

Description of proposed changes

This PR adds a comment to the already existing gallery example Custom symbols regarding own custom symbols.

Actually, issue #1349 suggests adding a standalone gallery example or tutorial. However, the macro language that is used to define own custom symbols is quite complicated, there is no difference to GMT, and the GMT documentation is quite detailed (please see https://docs.generic-mapping-tools.org/6.5/reference/custom-symbols.html#the-macro-language). Furthermore, plotting own custom symbols works similar to plotting built-in custom symbols (except including the .def file extension). So, mentioning the possibility of creating own custom symbols and the reference to the GMT documentation in the PyGMT gallery example Custom symbols may be enough.

Preview: https://pygmt-dev--3186.org.readthedocs.build/en/3186/gallery/symbols/custom_symbols.html

Fixes #1349 (partly)

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 command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Apr 21, 2024
@yvonnefroehlich yvonnefroehlich modified the milestones: 0.13.0, 0.12.0 Apr 21, 2024
@yvonnefroehlich yvonnefroehlich mentioned this pull request Apr 21, 2024
35 tasks
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 21, 2024
yvonnefroehlich and others added 3 commits April 21, 2024 14:33
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman merged commit 86cf1e2 into main Apr 21, 2024
9 checks passed
@seisman seisman deleted the add-comment-own-customsymbols branch April 21, 2024 14:04
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 21, 2024
@weiji14 weiji14 changed the title Gallery example "Custom symbols": Mention own coustom symbols Gallery example "Custom symbols": Mention own custom symbols Apr 26, 2024
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.

Gallery/tutorial example showing how to use/create custom symbols
3 participants