feat: support Pydantic descriptions #855
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhils
reviewed
Oct 31, 2025
pdoc/doc.py
Outdated
| elif _doc := _pydantic.get_computed_field_docstring( | ||
| cast(type, self.obj), | ||
| name, | ||
| ): |
There was a problem hiding this comment.
I would like to keep pydantic compexity out of pdoc.doc as much as possible. Can we please integrate this into get_field_docstring so that pdoc.doc remains pretty much unchanged? Computed fields are also still fields, so this is fine. :) Thanks!
There was a problem hiding this comment.
Absolutely, I've moved it into get_field_docstring
mhils
reviewed
Oct 31, 2025
|
Should be all good now. There is a known issue with mypy when using the See here: https://docs.pydantic.dev/2.0/usage/computed_fields/ |
|
Just added a brief note in the docs regarding this addition :) |
mhils
reviewed
Nov 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR should add support for Pydantic
computed_fielddescriptions.This is in addition to the current support for
Fielddescriptions, so it just allows for consistency when documenting Pydantic models.See issue #854
Let me know your thoughts !
Thanks again for the useful project :)