Skip to content

Commit ab6fc23

Browse files
rustyconoverclaude
andcommitted
docs: drop unresolvable Arg._validate cross-ref (strict mkdocs)
The bind-time constraint validator's docstring linked [`Arg._validate`][] (a private method with no doc page), which 'mkdocs build --strict' rejects as an unresolved cross-reference (the one failure in CI). Use a plain code span; likewise convert a stray :func: RST ref. No code change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 1c6be0a commit ab6fc23

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎vgi/arguments.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1514,7 +1514,7 @@ def validate_const_arg_constraints(
15141514
"""Enforce const-argument value constraints at bind time.
15151515
15161516
Const arguments are bind-time scalars, so validate them once (not per batch /
1517-
per group). Reuses [`Arg._validate`][], raising [`ArgumentValidationError`][]
1517+
per group). Reuses ``Arg._validate``, raising [`ArgumentValidationError`][]
15181518
for any value that violates a declared ``choices``/``ge``/``le``/``gt``/``lt``/
15191519
``pattern`` constraint — so a bad value fails fast at bind instead of silently
15201520
reaching ``compute()``/``update()``. Shared by the scalar and aggregate bind

‎vgi/scalar_function.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -651,8 +651,8 @@ def _validate_param_varargs_min(cls, input_schema: pa.Schema) -> None:
651651
def _validate_const_param_constraints(cls, arguments: Arguments) -> None:
652652
"""Enforce ``ConstParam`` value constraints at bind (choices/ge/le/gt/lt/pattern).
653653
654-
Delegates to the shared :func:`vgi.arguments.validate_const_arg_constraints`
655-
so the scalar and aggregate paths enforce identically — a discovered
654+
Delegates to the shared ``validate_const_arg_constraints`` helper so the
655+
scalar and aggregate paths enforce identically — a discovered
656656
constraint (surfaced via ``vgi_function_arguments()``) is binding for the
657657
modern API, matching the legacy ``Arg`` descriptor path.
658658
"""

0 commit comments

Comments
 (0)