From d8abe17618fae886388dcee095cc1b863b5bbdcb Mon Sep 17 00:00:00 2001
From: luxferre <chris@sr2.uk>
Date: Thu, 28 May 2026 11:00:00 +0100
Subject: [PATCH] docs: admin module docstrings

Issue: #13
---
 src/admin/config.py       |  4 ----
 src/admin/constants.py    |  6 +-----
 src/admin/dependencies.py | 10 +---------
 src/admin/exceptions.py   |  6 +-----
 src/admin/models.py       |  4 ----
 src/admin/router.py       |  5 ++---
 src/admin/schemas.py      |  4 ----
 src/admin/service.py      |  8 --------
 src/admin/utils.py        |  8 --------
 9 files changed, 5 insertions(+), 50 deletions(-)

diff --git a/src/admin/config.py b/src/admin/config.py
index 3139962..46e4142 100644
--- a/src/admin/config.py
+++ b/src/admin/config.py
@@ -1,7 +1,3 @@
 """
 Configurations for the admin module
-
-Configurations:
- - List: Description
- - Configs: Description
 """
\ No newline at end of file
diff --git a/src/admin/constants.py b/src/admin/constants.py
index 58a3b2a..c75163f 100644
--- a/src/admin/constants.py
+++ b/src/admin/constants.py
@@ -1,7 +1,3 @@
 """
-Constants and error codes for the admin module
-
-Constants:
- - List: Description
- - Consts: Description
+Constants for the admin module
 """
\ No newline at end of file
diff --git a/src/admin/dependencies.py b/src/admin/dependencies.py
index cb4c147..aff00b3 100644
--- a/src/admin/dependencies.py
+++ b/src/admin/dependencies.py
@@ -1,11 +1,3 @@
 """
-Router dependencies for the admin module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
+Dependencies for the admin module
 """
\ No newline at end of file
diff --git a/src/admin/exceptions.py b/src/admin/exceptions.py
index 644a8b0..513805c 100644
--- a/src/admin/exceptions.py
+++ b/src/admin/exceptions.py
@@ -1,7 +1,3 @@
 """
-Module specific exceptions for the admin module
-
-Exceptions:
- - List: Description
- - Exceptions: Description
+Custom exceptions for the admin module
 """
\ No newline at end of file
diff --git a/src/admin/models.py b/src/admin/models.py
index 1b60920..304e336 100644
--- a/src/admin/models.py
+++ b/src/admin/models.py
@@ -1,7 +1,3 @@
 """
 Database models for the admin module
-
-Models:
- - List: Description
- - Models: Description
 """
\ No newline at end of file
diff --git a/src/admin/router.py b/src/admin/router.py
index 13ac897..e0246a4 100644
--- a/src/admin/router.py
+++ b/src/admin/router.py
@@ -1,9 +1,8 @@
 """
 Router endpoints for the admin module
 
-Endpoints:
- - List: Description
- - Endpoints: Description
+Exports:
+ - router: fastapi.APIRouter
 """
 from fastapi import APIRouter
 
diff --git a/src/admin/schemas.py b/src/admin/schemas.py
index 4490920..1289bcb 100644
--- a/src/admin/schemas.py
+++ b/src/admin/schemas.py
@@ -1,7 +1,3 @@
 """
 Pydantic models for the admin module
-
-Models:
- - List: Description
- - Models: Description
 """
\ No newline at end of file
diff --git a/src/admin/service.py b/src/admin/service.py
index 1cd5069..1db3599 100644
--- a/src/admin/service.py
+++ b/src/admin/service.py
@@ -1,11 +1,3 @@
 """
 Module specific business logic for the admin module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """
\ No newline at end of file
diff --git a/src/admin/utils.py b/src/admin/utils.py
index 4e316d1..e570f14 100644
--- a/src/admin/utils.py
+++ b/src/admin/utils.py
@@ -1,11 +1,3 @@
 """
 Non-business logic reusable functions and classes for the admin module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """
\ No newline at end of file