From 5bb3a9026f097d5d76b2324f4e5cad81da548640 Mon Sep 17 00:00:00 2001 From: Ed_ Date: Wed, 13 May 2026 22:31:34 -0400 Subject: [PATCH] fix(models): restore original module docstring --- src/models.py | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/src/models.py b/src/models.py index ffd7b92..bd78a59 100644 --- a/src/models.py +++ b/src/models.py @@ -1,6 +1,9 @@ """ Models - Core data structures for MMA orchestration and project configuration. +This module defines the primary dataclasses used throughout the Manual Slop +application for representing tasks, tracks, and execution context. + Key Data Structures: - Ticket: Atomic unit of work with status, dependencies, and context requirements - Track: Collection of tickets with a shared goal @@ -9,8 +12,29 @@ Key Data Structures: - TrackState: Serializable track state with discussion history - FileItem: File configuration with auto-aggregate and force-full flags -Thread Safety: These dataclasses are NOT thread-safe. -Serialization: All dataclasses provide to_dict() and from_dict() for TOML/JSON persistence. +Status Machine (Ticket): + todo -> in_progress -> completed + | | + v v + blocked blocked + +Serialization: + All dataclasses provide to_dict() and from_dict() class methods for TOML/JSON + persistence via project_manager.py. + +Thread Safety: + These dataclasses are NOT thread-safe. Callers must synchronize mutations + if sharing instances across threads (e.g., during ConductorEngine execution). + +Configuration Integration: + - load_config() / save_config() read/write the global config.toml + - AGENT_TOOL_NAMES defines the canonical list of MCP tools available to agents + +See Also: + - docs/guide_mma.md for MMA orchestration documentation + - src/dag_engine.py for TrackDAG and ExecutionEngine + - src/multi_agent_conductor.py for ConductorEngine + - src/project_manager.py for persistence layer """ from __future__ import annotations import datetime