Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Class documentation for Pydantic configs. #42

Open
braceal opened this issue Aug 9, 2021 · 0 comments
Open

Class documentation for Pydantic configs. #42

braceal opened this issue Aug 9, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@braceal
Copy link
Collaborator

braceal commented Aug 9, 2021

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."""
@braceal braceal added the enhancement New feature or request label Aug 9, 2021
@braceal braceal mentioned this issue May 22, 2022
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant