From 01c49ca34cf5f24ef1c8d55c501d18f15642f240 Mon Sep 17 00:00:00 2001
From: luxferre <chris@sr2.uk>
Date: Thu, 28 May 2026 15:41:10 +0100
Subject: [PATCH] docs: module template docstrings

---
 src/_module_template/config.py       |  6 ++----
 src/_module_template/constants.py    |  6 ++----
 src/_module_template/dependencies.py | 11 +++--------
 src/_module_template/exceptions.py   |  5 ++---
 src/_module_template/models.py       |  8 +++++---
 src/_module_template/router.py       | 11 +++++------
 src/_module_template/schemas.py      |  9 +++++----
 src/_module_template/service.py      | 10 ++--------
 src/_module_template/utils.py        | 10 +---------
 9 files changed, 27 insertions(+), 49 deletions(-)

diff --git a/src/_module_template/config.py b/src/_module_template/config.py
index 4be170e..45d3182 100644
--- a/src/_module_template/config.py
+++ b/src/_module_template/config.py
@@ -1,7 +1,5 @@
 """
-Configurations for <this module>
+Configurations for the <this> module
 
-Configurations:
- - List: Description
- - Configs: Description
+Exports:
 """
\ No newline at end of file
diff --git a/src/_module_template/constants.py b/src/_module_template/constants.py
index e1df957..cc72009 100644
--- a/src/_module_template/constants.py
+++ b/src/_module_template/constants.py
@@ -1,7 +1,5 @@
 """
-Constants and error codes for <this module>
+Constants for the <this> module
 
-Constants:
- - List: Description
- - Consts: Description
+Exports:
 """
\ No newline at end of file
diff --git a/src/_module_template/dependencies.py b/src/_module_template/dependencies.py
index 7447aaf..71750bc 100644
--- a/src/_module_template/dependencies.py
+++ b/src/_module_template/dependencies.py
@@ -1,11 +1,6 @@
 """
-Router dependencies for <this module>
+Dependencies related to the <this> module
 
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
+Exports:
+ - <dep_name>: <return_type>: <description>
 """
\ No newline at end of file
diff --git a/src/_module_template/exceptions.py b/src/_module_template/exceptions.py
index 5debbb4..402940a 100644
--- a/src/_module_template/exceptions.py
+++ b/src/_module_template/exceptions.py
@@ -1,7 +1,6 @@
 """
-Module specific exceptions for <this module>
+Exceptions related to the <this> modules
 
 Exceptions:
- - List: Description
- - Exceptions: Description
+ - <ExceptionName>: Details e.g. optional params
 """
\ No newline at end of file
diff --git a/src/_module_template/models.py b/src/_module_template/models.py
index 6d2494b..d03c882 100644
--- a/src/_module_template/models.py
+++ b/src/_module_template/models.py
@@ -1,7 +1,9 @@
 """
-Database models for <this module>
+Database models for the <this> module
 
 Models:
- - List: Description
- - Models: Description
+ - <ModelName>:
+  - <normal_columns[FK][PK]>
+  - <orm_relationships>
+  - <calculated_properties>
 """
\ No newline at end of file
diff --git a/src/_module_template/router.py b/src/_module_template/router.py
index 2eb8569..d96d7ee 100644
--- a/src/_module_template/router.py
+++ b/src/_module_template/router.py
@@ -1,13 +1,12 @@
 """
-Router endpoints for <this module>
+Router endpoints for the <this> module
 
-Endpoints:
- - List: Description
- - Endpoints: Description
+Exports:
+ - router: fastapi.APIRouter
 """
 from fastapi import APIRouter
 
 
-_router = APIRouter(
+router = APIRouter(
 	tags=[""],
-)
\ No newline at end of file
+)
diff --git a/src/_module_template/schemas.py b/src/_module_template/schemas.py
index a074c75..71cfc07 100644
--- 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 ""
 """
\ No newline at end of file
diff --git a/src/_module_template/service.py b/src/_module_template/service.py
index 7365fa9..139a237 100644
--- a/src/_module_template/service.py
+++ b/src/_module_template/service.py
@@ -1,11 +1,5 @@
 """
-Module specific business logic for <this module>
+Module specific business logic for the <this> module
 
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
+Exports:
 """
\ No newline at end of file
diff --git a/src/_module_template/utils.py b/src/_module_template/utils.py
index f2da15a..4e99ff6 100644
--- a/src/_module_template/utils.py
+++ b/src/_module_template/utils.py
@@ -1,11 +1,3 @@
 """
-Non-business logic reusable functions and classes for <this module>
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
+Non-business logic reusable functions and classes for the <this> module
 """
\ No newline at end of file