Skip to content

fix: let a Field description win over the docstring - #86

Merged
edornd merged 1 commit into
v2from
85-field-description
Nov 11, 2026
Merged

edornd merged 1 commit into
v2from
85-field-description

Conversation

@edornd

@edornd edornd commented Nov 11, 2026

Copy link
Copy Markdown
Owner

When a parameter has both a Field(description=...) in its Annotated hint and an Args: entry in the docstring, the Field description now wins. Before, the docstring silently replaced it. A test sets both, and the commands page states the rule.

Closes #85

A Field(description=...) in an Annotated hint now takes precedence over
the docstring's Args entry for the same parameter, as the code comment
already claimed.

Closes #85
@edornd
edornd merged commit 89481ad into v2 Nov 11, 2026
6 checks passed
@edornd
edornd deleted the 85-field-description branch November 11, 2026 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant