1
0
Fork 0
forked from sr2/cloud-api

docs: admin module docstrings

Issue: #13
This commit is contained in:
Chris Milne 2026-05-28 11:00:00 +01:00
parent 88a64d2047
commit d8abe17618
9 changed files with 5 additions and 50 deletions

View file

@ -1,7 +1,3 @@
"""
Configurations for the admin module
Configurations:
- List: Description
- Configs: Description
"""

View file

@ -1,7 +1,3 @@
"""
Constants and error codes for the admin module
Constants:
- List: Description
- Consts: Description
Constants for the admin module
"""

View file

@ -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
"""

View file

@ -1,7 +1,3 @@
"""
Module specific exceptions for the admin module
Exceptions:
- List: Description
- Exceptions: Description
Custom exceptions for the admin module
"""

View file

@ -1,7 +1,3 @@
"""
Database models for the admin module
Models:
- List: Description
- Models: Description
"""

View file

@ -1,9 +1,8 @@
"""
Router endpoints for the admin module
Endpoints:
- List: Description
- Endpoints: Description
Exports:
- router: fastapi.APIRouter
"""
from fastapi import APIRouter

View file

@ -1,7 +1,3 @@
"""
Pydantic models for the admin module
Models:
- List: Description
- Models: Description
"""

View file

@ -1,11 +1,3 @@
"""
Module specific business logic for the admin module
Classes:
- List: Description
- Classes: Description
Functions:
- List: Description
- Functions: Description
"""

View file

@ -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
"""