Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Feb 15, 2025

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

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

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 maintenance Boring but important stuff for the core devs label Feb 15, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Feb 15, 2025
@yvonnefroehlich yvonnefroehlich changed the title POC: WIP: DOC: Figure.meca: Use table for supported conventions in docs DOC / Figure.meca: Use table for supported conventions in docs Feb 16, 2025
@yvonnefroehlich yvonnefroehlich changed the title DOC / Figure.meca: Use table for supported conventions in docs DOC / Figure.meca: Use table for supported conventions Feb 16, 2025
@seisman seisman added this to the 0.15.0 milestone Feb 16, 2025
@seisman seisman added documentation Improvements or additions to documentation and removed maintenance Boring but important stuff for the core devs labels Feb 16, 2025
Comment on lines 251 to 252
- | moment components
| in dynes-cm
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- | moment components
| in dynes-cm
- | moment components
| in :math:`10*{exponent}` dyne-cm

Copy link
Member

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.

Copy link
Member Author

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

@seisman seisman added the needs review This PR has higher priority and needs review. label Feb 18, 2025
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Feb 18, 2025
Copy link
Member

@seisman seisman left a 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.

@seisman
Copy link
Member

seisman commented Feb 18, 2025

Perhaps we should add the "skip-changelog" label?

@yvonnefroehlich yvonnefroehlich added the skip-changelog Skip adding Pull Request to changelog label Feb 18, 2025
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 19, 2025
@seisman seisman merged commit 9dda628 into main Feb 19, 2025
22 of 23 checks passed
@seisman seisman deleted the add-table-convention branch February 19, 2025 05:45
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 skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants