Skip to content

feat: Supports Pydantic Field defined via Annotated#46

Merged
pawamoy merged 1 commit intomkdocstrings:mainfrom
dolfim-ibm:fix-annotated-fields
Jan 13, 2026
Merged

feat: Supports Pydantic Field defined via Annotated#46
pawamoy merged 1 commit intomkdocstrings:mainfrom
dolfim-ibm:fix-annotated-fields

Conversation

@dolfim-ibm
Copy link
Copy Markdown
Contributor

For reviewers

  • I did not use AI
  • I used AI and thorougly reviewed every code/docs change

Description of the change

The proposed changes are able to detect when the Field() is defined with Annotated[type, Field(...)] and it overwrites the annotation type such that the final docs won't show the full Annotated.

Example

Before

image

After

image

Relevant resources

@dolfim-ibm
Copy link
Copy Markdown
Contributor Author

@pawamoy I noticed the same CI issue when running make check locally but I didn't know if that required a fix since it wasn't touched by the PR changes. Let me know if we should address those linter messages as well.

@dolfim-ibm
Copy link
Copy Markdown
Contributor Author

@pawamoy any update for this fix?

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Jan 13, 2026

Thanks a lot @dolfim-ibm! This looks good 🙂 I'll just check it locally before merging.

@pawamoy pawamoy merged commit 5021332 into mkdocstrings:main Jan 13, 2026
2 of 3 checks passed
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.

bug: Annotated causes fields to not show up with description

2 participants