Skip to content

DOC: Technical Reference: Add table for text formatting #3976

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jun 15, 2025

Description of proposed changes

Following https://docs.generic-mapping-tools.org/dev/text.html#description, this PR addes a table to the Technical References for formatting text.

Preview: https://pygmt-dev--3976.org.readthedocs.build/en/3976/techref/text_formatting.html

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 self-assigned this Jun 15, 2025
@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Jun 15, 2025
yvonnefroehlich and others added 2 commits June 17, 2025 16:32
Co-authored-by: Dongdong Tian <[email protected]>
@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Jun 17, 2025

A new ruff version (0.12.0) was released a few hours ago (https://pypi.org/project/ruff/) leading to several (~20) failing Style checks (https://github.com/GenericMappingTools/pygmt/actions/runs/15714747994/job/44281566411?pr=3976).

@seisman
Copy link
Member

seisman commented Jun 18, 2025

A new ruff version (0.12.0) was released a few hours ago (https://pypi.org/project/ruff/) leading to several (~20) failing Style checks (https://github.com/GenericMappingTools/pygmt/actions/runs/15714747994/job/44281566411?pr=3976).

Yes, addressed in #3980.

@yvonnefroehlich yvonnefroehlich added this to the 0.16.0 milestone Jun 18, 2025
@seisman seisman modified the milestones: 0.16.0, 0.17.0 Jun 19, 2025
@seisman
Copy link
Member

seisman commented Jun 19, 2025

Perhaps we should also update https://www.pygmt.org/dev/tutorials/basics/text.html, maybe in a separate PR?

Co-authored-by: Dongdong Tian <[email protected]>
@yvonnefroehlich
Copy link
Member Author

Perhaps we should also update https://www.pygmt.org/dev/tutorials/basics/text.html, maybe in a separate PR?

Good point! Adding a section to this tutorial sounds good to me, or do we just want to add a link to this Technical Reference page?

@seisman
Copy link
Member

seisman commented Jun 20, 2025

Maybe a separate tutorial or gallery example is better?

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.

3 participants