Skip to content

Commit 25c983b

Browse files
rustyconoverclaude
andcommitted
docs: fix strict-build cross-refs to private _descriptor_spec
The setting/attach_option consolidation added mkdocstrings autoref links ([`_SpecBase`][vgi.catalog._descriptor_spec._SpecBase] etc.) pointing at the private _descriptor_spec module, which is not rendered in the API docs — so `mkdocs build --strict` aborted on unresolved cross-reference targets. Demote those links to plain code spans naming the module. Verified: `mkdocs build --strict` exits 0 with no autoref warnings. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 03852fd commit 25c983b

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

vgi/catalog/attach_option.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class AttachOptionSpec(_SpecBase):
2727
"""Extracted attach-option metadata for catalog discovery serialization.
2828
2929
The resolved form of an `AttachOption`. See
30-
[`_SpecBase`][vgi.catalog._descriptor_spec._SpecBase] for the field and
30+
`_SpecBase` (in `vgi.catalog._descriptor_spec`) for the field and
3131
wire-format definition.
3232
"""
3333

@@ -39,7 +39,7 @@ class AttachOption(_DescriptorBase):
3939
Use with Annotated type hints to declare options in a Worker's
4040
AttachOptions inner class. The Arrow type is resolved from the base type
4141
in the Annotated hint. See
42-
[`_DescriptorBase`][vgi.catalog._descriptor_spec._DescriptorBase] for the
42+
`_DescriptorBase` (in `vgi.catalog._descriptor_spec`) for the
4343
``desc`` and ``arrow_type`` attributes.
4444
"""
4545

vgi/catalog/setting.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class SettingSpec(_SpecBase):
2323
"""Extracted setting metadata for catalog serialization.
2424
2525
This is the resolved form of a `Setting`, with all types inferred and
26-
ready for serialization. See [`_SpecBase`][vgi.catalog._descriptor_spec._SpecBase]
26+
ready for serialization. See `_SpecBase` (in `vgi.catalog._descriptor_spec`)
2727
for the field and wire-format definition.
2828
"""
2929

@@ -34,7 +34,7 @@ class Setting(_DescriptorBase):
3434
3535
Use with `Annotated` type hints to declare settings in a [`Worker`][]'s Settings class.
3636
The Arrow type is resolved from the base type in the `Annotated` hint. See
37-
[`_DescriptorBase`][vgi.catalog._descriptor_spec._DescriptorBase] for the
37+
`_DescriptorBase` (in `vgi.catalog._descriptor_spec`) for the
3838
``desc`` and ``arrow_type`` attributes.
3939
"""
4040

0 commit comments

Comments
 (0)