From bd2b48cb892725e245da56d68a0387e35266b97c Mon Sep 17 00:00:00 2001 From: Alexander Whitestone Date: Mon, 23 Mar 2026 21:53:17 -0400 Subject: [PATCH] docs: add module docstrings to 9 undocumented files Adds concise module-level docstrings to every Python file that lacked one, covering config, dashboard models/routes, chat_bridge vendor init, CLI entry point, and sovereignty perception cache. Fixes #1296 Co-Authored-By: Claude Sonnet 4.6 --- src/__init__.py | 1 + src/config.py | 5 +++++ src/dashboard/models/calm.py | 1 + src/dashboard/models/database.py | 1 + src/dashboard/routes/agents.py | 1 + src/dashboard/routes/calm.py | 1 + src/integrations/chat_bridge/vendors/__init__.py | 1 + src/timmy/cli.py | 1 + src/timmy/sovereignty/perception_cache.py | 1 + 9 files changed, 13 insertions(+) diff --git a/src/__init__.py b/src/__init__.py index e69de29b..82589cec 100644 --- a/src/__init__.py +++ b/src/__init__.py @@ -0,0 +1 @@ +"""Timmy Time Dashboard — source root package.""" diff --git a/src/config.py b/src/config.py index ad40c1bb..257530b0 100644 --- a/src/config.py +++ b/src/config.py @@ -1,3 +1,8 @@ +"""Central pydantic-settings configuration for Timmy Time Dashboard. + +All environment variable access goes through the ``settings`` singleton +exported from this module — never use ``os.environ.get()`` in app code. +""" import logging as _logging import os import sys diff --git a/src/dashboard/models/calm.py b/src/dashboard/models/calm.py index 8bb8d373..84817d16 100644 --- a/src/dashboard/models/calm.py +++ b/src/dashboard/models/calm.py @@ -1,3 +1,4 @@ +"""SQLAlchemy ORM models for the CALM task-management and journaling system.""" from datetime import UTC, date, datetime from enum import StrEnum diff --git a/src/dashboard/models/database.py b/src/dashboard/models/database.py index 7bb28a01..1233e826 100644 --- a/src/dashboard/models/database.py +++ b/src/dashboard/models/database.py @@ -1,3 +1,4 @@ +"""SQLAlchemy engine, session factory, and declarative Base for the CALM module.""" import logging from pathlib import Path diff --git a/src/dashboard/routes/agents.py b/src/dashboard/routes/agents.py index 455ca008..dab6dae3 100644 --- a/src/dashboard/routes/agents.py +++ b/src/dashboard/routes/agents.py @@ -1,3 +1,4 @@ +"""Dashboard routes for agent chat interactions and tool-call display.""" import json import logging from datetime import datetime diff --git a/src/dashboard/routes/calm.py b/src/dashboard/routes/calm.py index 6a8eef28..6739f5be 100644 --- a/src/dashboard/routes/calm.py +++ b/src/dashboard/routes/calm.py @@ -1,3 +1,4 @@ +"""Dashboard routes for the CALM task management and daily journaling interface.""" import logging from datetime import UTC, date, datetime diff --git a/src/integrations/chat_bridge/vendors/__init__.py b/src/integrations/chat_bridge/vendors/__init__.py index e69de29b..7c357e23 100644 --- a/src/integrations/chat_bridge/vendors/__init__.py +++ b/src/integrations/chat_bridge/vendors/__init__.py @@ -0,0 +1 @@ +"""Vendor-specific chat platform adapters (e.g. Discord) for the chat bridge.""" diff --git a/src/timmy/cli.py b/src/timmy/cli.py index b05a249a..63ee973e 100644 --- a/src/timmy/cli.py +++ b/src/timmy/cli.py @@ -1,3 +1,4 @@ +"""Typer CLI entry point for the ``timmy`` command (chat, think, status).""" import asyncio import logging import subprocess diff --git a/src/timmy/sovereignty/perception_cache.py b/src/timmy/sovereignty/perception_cache.py index fe0df9b9..4c69a300 100644 --- a/src/timmy/sovereignty/perception_cache.py +++ b/src/timmy/sovereignty/perception_cache.py @@ -1,3 +1,4 @@ +"""OpenCV template-matching cache for sovereignty perception (screen-state recognition).""" from __future__ import annotations import json -- 2.43.0