Skip to content

Fix uses of default role in the docs#779

Merged
AlexWaygood merged 1 commit into
mainfrom
alex/td-docs
Jul 2, 2026
Merged

Fix uses of default role in the docs#779
AlexWaygood merged 1 commit into
mainfrom
alex/td-docs

Conversation

@AlexWaygood

Copy link
Copy Markdown
Member

This is ReST, not MarkDown, so the default role is rendering as italics rather than as code in our docs: https://typing-extensions.readthedocs.io/en/latest/#sentinel-objects. Apparently sphinx-lint's default-role check, which would have flagged this, is disabled by default. I've tweaked our pre-commit configuration to enable that check, and filed sphinx-contrib/sphinx-lint#165 to suggest that sphinx-lint's documentation be improved to more clearly indicate which checks are enable/disabled by default.

@AlexWaygood AlexWaygood added the documentation Improvements or additions to documentation label Jul 2, 2026
@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.26%. Comparing base (c461223) to head (928e123).

@@           Coverage Diff           @@
##             main     #779   +/-   ##
=======================================
  Coverage   97.26%   97.26%           
=======================================
  Files           3        3           
  Lines        7860     7860           
=======================================
  Hits         7645     7645           
  Misses        215      215           
Flag Coverage Δ
3.10 88.85% <ø> (ø)
3.10.4 88.85% <ø> (ø)
3.11 88.02% <ø> (ø)
3.11.0 87.27% <ø> (ø)
3.12 87.96% <ø> (ø)
3.12.0 87.95% <ø> (ø)
3.13 83.39% <ø> (ø)
3.13.0 84.09% <ø> (ø)
3.14 79.53% <ø> (ø)
3.9 89.53% <ø> (ø)
3.9.12 89.53% <ø> (ø)
pypy3.10 88.68% <ø> (ø)
pypy3.11 87.88% <ø> (ø)
pypy3.9 89.37% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AlexWaygood AlexWaygood merged commit 27c70f3 into main Jul 2, 2026
25 checks passed
@AlexWaygood AlexWaygood deleted the alex/td-docs branch July 2, 2026 18:25
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.

2 participants