Gallery example "Custom symbols": Mention own custom symbols #3186
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code