Skip to content

linkify_issues(docs[SetupDict]): Document TypedDict fields #81

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.

Sign up for GitHub

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

Merged
tony merged 2 commits into from
Jul 26, 2026
Merged

linkify_issues(docs[SetupDict]): Document TypedDict fields #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c256eb
linkify_issues(docs[SetupDict]): Document fields
tony Jul 25, 2026
d042bae
docs(CHANGES) Documented class fields
tony Jul 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ $ uvx --from 'gp-libs' --prerelease allow gp-libs
_Notes on upcoming releases will be added here_
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->

### Documentation

#### Extension metadata fields are described (#81)

The `TypedDict` returned from `linkify_issues`'s Sphinx `setup()` now says
what each key holds. They previously reached the rendered API reference as
"Alias for field number 0" or as a bare name carrying only its type.

### Development

#### CI actions updated to current majors
Expand Down
15 changes: 14 additions & 1 deletion src/linkify_issues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,20 @@ def condition(node: nodes.Node) -> bool:


class SetupDict(t.TypedDict):
"""Setup mapping for Sphinx app."""
"""Setup mapping for Sphinx app.

Attributes
----------
version : str
Version of this extension, returned to Sphinx so it can invalidate
its build environment when the extension changes.
parallel_read_safe : bool
Whether Sphinx may read source files in parallel while this
extension is loaded.
parallel_write_safe : bool
Whether Sphinx may write output in parallel while this extension is
loaded.
"""

version: str
parallel_read_safe: bool
Expand Down