Doc fixes #498
Merged
Doc fixes #498
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
why: sphinx-autodoc-typehints emitted forward reference warnings for aliases only defined under TYPE_CHECKING. what: - provide fallback DataclassInstance, move TypeAlias imports out of TYPE_CHECKING, and import StrPath/TypeGuard at runtime - ensure sync/url/registry modules import shared aliases directly to make type hints resolvable during docs build - tidy _internal types docstring wording to drop glossary term that caused warnings
why: Sphinx reported duplicate object descriptions for SubprocessCommand fields and URL rule attributes. what: - remove redundant attribute lists that created duplicate targets in subprocess and URL base docs
why: Sphinx warned about duplicate explicit target name "hg update" in Hg.pull docstring. what: - reference hg pull manpage instead of update to avoid conflicting target
why: project style prefers namespaced typing usage (47188b8). what: - drop direct TypeGuard import and annotate helper using t.TypeGuard
why: Style avoids direct imports from typing; stay consistent with commit 47188b8. what: - switch runtime aliases to t.TypeAlias across registry, _internal types/run/subprocess, and tests - remove direct TypeAlias imports
why: docutils warned about unmatched interpreted text delimiters in run() docstring. what: - wrap command error and callback examples in double backticks - simplify future change note to avoid backtick imbalance
why: myst header lints flagged non-consecutive levels (H2->H4). what: - promote fixture and commands subsections to H3
why: Sphinx warned about undefined labels and duplicate module objects.
what:
- replace pytest fixture ref with direct link and drop redundant {module} directive in pytest-plugin
- switch vcspull ref to external link and remove unused footnote in url guide
why: avoid noisy intersphinx fetch warnings when inventories are unreachable. what: - add short timeout and suppress intersphinx warnings
why: enforce project import/type alias style after rebase. what: - reflow long docstring line - apply sorted imports - switch InitCmdArgs to t.TypeAlias
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #498 +/- ##
==========================================
+ Coverage 53.82% 53.85% +0.03%
==========================================
Files 38 38
Lines 5663 5676 +13
Branches 1063 1063
==========================================
+ Hits 3048 3057 +9
- Misses 2104 2108 +4
Partials 511 511 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
added a commit
that referenced
this pull request
Dec 6, 2025
why: document recent doc cleanup work without moving upcoming placeholder. what: - add changelog entry under unreleased section for doc warning / reference fixes
Member
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
…pehints why: Types in TYPE_CHECKING blocks (used for circular import avoidance) cause sphinx-autodoc-typehints to emit warnings about unresolvable forward references. These warnings are expected and safe to suppress. what: - Add suppress_warnings config for sphinx_autodoc_typehints.forward_reference
why: document recent doc cleanup work without moving upcoming placeholder. what: - add changelog entry under unreleased section for doc warning / reference fixes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.