-
Notifications
You must be signed in to change notification settings - Fork 229
DOC / Figure.meca: Use table for supported conventions #3811
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
Conversation
Co-authored-by: Dongdong Tian <[email protected]>
pygmt/src/meca.py
Outdated
- | moment components | ||
| in dynes-cm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- | moment components | |
| in dynes-cm | |
- | moment components | |
| in :math:`10*{exponent}` dyne-cm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could also discuss to use only dyn-cm, without the e at the end. I find both versions online but the one without the e is much more prominent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jupp! Actually, there are several versions used: "dynes-cm", "dyne-cm", and "dyn-cm" with and without the hyphen 🙃. I prefer “dyn”. Personally, I do not like this hyphen because it's stickly speaking a multiplication between dyn
and cm
(same as for 10^-7 N m
).
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
Perhaps we should add the "skip-changelog" label? |
Description of proposed changes
Add table for the supported conventions of
Figure.meca
to docs.Tabels in RST: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/tables.html
See comment #3517 (comment)
Preview: https://pygmt-dev--3811.org.readthedocs.build/en/3811/api/generated/pygmt.Figure.meca.html#pygmt.Figure.meca
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