Skip to content

Class documentation for Pydantic configs. #42

@braceal

Description

@braceal

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."""

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions