docs: module template docstrings

src/_module_template/config.py

@@ -1,7 +1,5 @@
 """
-Configurations for <this module>
+Configurations for the <this> module
 
-Configurations:
+Exports:
- - List: Description
- - Configs: Description
 """

src/_module_template/constants.py

@@ -1,7 +1,5 @@
 """
-Constants and error codes for <this module>
+Constants for the <this> module
 
-Constants:
+Exports:
- - List: Description
- - Consts: Description
 """

src/_module_template/dependencies.py

@@ -1,11 +1,6 @@
 """
-Router dependencies for <this module>
+Dependencies related to the <this> module
 
-Classes:
+Exports:
- - List: Description
+ - <dep_name>: <return_type>: <description>
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """

src/_module_template/exceptions.py

@@ -1,7 +1,6 @@
 """
-Module specific exceptions for <this module>
+Exceptions related to the <this> modules
 
 Exceptions:
- - List: Description
+ - <ExceptionName>: Details e.g. optional params
- - Exceptions: Description
 """

src/_module_template/models.py

@@ -1,7 +1,9 @@
 """
-Database models for <this module>
+Database models for the <this> module
 
 Models:
- - List: Description
+ - <ModelName>:
- - Models: Description
+  - <normal_columns[FK][PK]>
+  - <orm_relationships>
+  - <calculated_properties>
 """

src/_module_template/router.py

@@ -1,13 +1,12 @@
 """
-Router endpoints for <this module>
+Router endpoints for the <this> module
 
-Endpoints:
+Exports:
- - List: Description
+ - router: fastapi.APIRouter
- - Endpoints: Description
 """
 from fastapi import APIRouter
 
 
-_router = APIRouter(
+router = APIRouter(
 	tags=[""],
 )

src/_module_template/schemas.py

@@ -1,7 +1,8 @@
 """
-Pydantic models for <this module>
+Pydantic models for the <this> module
 
-Models:
+Models follow the nomenclature of:
- - List: Description
+- Sub-models: "<Resource><Opt:>Schema"
- - Models: Description
+- Mixins: "<Attribute>Mixin"
+- Models: "<Module><Method><Resource><Opt:Resource><Direction>" ie ""
 """

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:
+Exports:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """

src/_module_template/utils.py

@@ -1,11 +1,3 @@
 """
-Non-business logic reusable functions and classes for <this module>
+Non-business logic reusable functions and classes for the <this> module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """