From e44e2bd6277670471b1f97f87d7bc3b66801df5a Mon Sep 17 00:00:00 2001 From: luxferre Date: Thu, 28 May 2026 14:59:27 +0100 Subject: [PATCH] docs: global docstrings Issue: #13 --- src/config.py | 6 ++++-- src/schemas.py | 7 +++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/config.py b/src/config.py index b1874d3..120354e 100644 --- a/src/config.py +++ b/src/config.py @@ -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 diff --git a/src/schemas.py b/src/schemas.py index 52b0f94..812b574 100644 --- a/src/schemas.py +++ b/src/schemas.py @@ -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