-
Notifications
You must be signed in to change notification settings - Fork 213
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 new documentation group for "technical explanations" or "showcases" #2834
Comments
Thanks @seisman for pointing out this aspect! This documentation concept page looks interesting - thanks for posting the link! We have multiple docstrings and examples that mention these 2-character codes for the
I agree it would be better to have this bundled in one place, and link to it in the docstrings and examples. If we decide on any kind of "technical reference", what would make sense to include beside these 2-character codes? Maybe:
|
I believe there are a lot that can be added to this "section":
|
Ping @GenericMappingTools/pygmt-maintainers for more discussions on this. |
Justification codes like
BL
andTR
are commonly used in GMT and PyGMT. Currently, we have explanations like:Instead of repeatedly explaining justification codes in different plotting methods, I feel it makes more sense to have a separate page explaining justification codes then we can link to this page when necessary.
Looking at the divio documentation system, I feel it should belong to "Reference" documentation, rather than "Tutorials". Currently, we have an "API Reference" page (https://www.pygmt.org/dev/api/index.html), but apparently "justification" is not an API thing. Maybe we need another section like "Technical Reference" or something else?
The text was updated successfully, but these errors were encountered: