You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Each pydantic data class should have documentation on each parameter. It will also be very important to document the exceptions validation can raise so users know how to set the parameters.
To do this, after each property in the pydantic class, add a """_description_""" block. For example:
class MyConfig(BaseSettings):
"""Configuration for ..."""
output_path: Path
"""Path to write output files to."""
The text was updated successfully, but these errors were encountered:
Each pydantic data class should have documentation on each parameter. It will also be very important to document the exceptions validation can raise so users know how to set the parameters.
To do this, after each property in the pydantic class, add a
"""_description_"""
block. For example:The text was updated successfully, but these errors were encountered: