docs: global docstrings

Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 14:59:27 +01:00
parent 43cb7e700d
commit e44e2bd627
2 changed files with 11 additions and 2 deletions

View file

@ -1,8 +1,10 @@
"""
Global configurations: import settings, app_configs
Global configurations
Classes:
Exports:
- CustomBaseSettings - Base class to be used by all modules for loading configs
- settings: Global configurations object
- app_configs: Dict generated from configs, used in app initialisation
"""
from typing import Any

View file

@ -1,3 +1,10 @@
"""
Global Pydantic schemas
Exports:
- CustomBaseModel: Schema used for all other Pydantic models
- ResourceName
"""
from pydantic import BaseModel
from typing import Optional