linkify_issues(docs[SetupDict]): Document TypedDict fields#81
Open
tony wants to merge 2 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #81 +/- ##
=======================================
Coverage 76.32% 76.32%
=======================================
Files 15 15
Lines 1018 1018
=======================================
Hits 777 777
Misses 241 241 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
attributes-backfill
branch
from
July 26, 2026 00:57
ab80392 to
fd3727d
Compare
why: Sphinx autodoc renders TypedDict fields whether or not they are described, so the extension metadata keys ship to the API reference bare, leaving readers to guess what the setup mapping promises Sphinx. what: - Add an Attributes section to SetupDict covering the extension version and the parallel read/write safety flags
why: The unreleased entry did not record that class fields now carry descriptions where the API reference renders them. what: - Note the described fields under Documentation
tony
force-pushed
the
attributes-backfill
branch
from
July 26, 2026 01:22
686e745 to
d042bae
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
SetupDictreached the API reference with its keys rendered bare — autodoc emits every field of aNamedTuple, dataclass, orTypedDictwhether or not the docstring describes it, so an undocumented field ships as "Alias for field number 0" or with no description at all. This adds a NumPy-styleAttributessection naming each key, its type, and what it holds. Docstrings only: no code, signature, or field-order changes.Gates run and passing:
just ruff-format,just ruff,uv run mypy .,just test,just build-docs.The docs build now emits new duplicate-object warnings for
linkify_issues.SetupDict.version,linkify_issues.SetupDict.parallel_read_safe, andlinkify_issues.SetupDict.parallel_write_safe— the NumPy preprocessor emits an.. attribute::for each documented field while autodoc renders the same field, so Sphinx sees each described twice. Trunk builds clean, so these arrive with this change. They are left unsuppressed here; the fix belongs in gp-sphinx and is landing there separately.Closes #80