docs: module template docstrings

2026-05-28 15:41:10 +01:00 · 2026-05-28 15:41:10 +01:00 · 01c49ca34c
commit 01c49ca34c
parent b3085e85fd
9 changed files with 27 additions and 49 deletions
--- a/src/_module_template/schemas.py
+++ b/src/_module_template/schemas.py
@ -1,7 +1,8 @@
 """
-Pydantic models for <this module>
+Pydantic models for the <this> module

-Models:
- - List: Description
- - Models: Description
+Models follow the nomenclature of:
+- Sub-models: "<Resource><Opt:>Schema"
+- Mixins: "<Attribute>Mixin"
+- Models: "<Module><Method><Resource><Opt:Resource><Direction>" ie ""
 """