Rockachopa/Timmy-time-dashboard
1
0
Fork 2
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

[loop-generated] [refactor] Add docstrings to 20 undocumented classes in src/ #1130

New Issue
Closed
opened 2026-03-23 18:24:18 +00:00 by Timmy · 1 comment
Timmy commented 2026-03-23 18:24:18 +00:00
Owner
Copy Link

Problem

20 classes in src/ are missing class-level docstrings:

dashboard/models/calm.py (4 classes):

  • TaskState, TaskCertainty, Task, JournalEntry

dashboard/ (3 classes):

  • TokenPayload (discord.py, telegram.py), _EnumLike (work_orders.py), PeriodType (scorecard_service.py)

infrastructure/ (3 classes):

  • Message (chat_store.py), Notification (push.py), Intent (voice/nlu.py)

timmy/ (4 classes):

  • ApprovalItem (approvals.py), Briefing (briefing.py), MockLLMClient, MockCompletion (research_tools.py)

Other (3 classes):

  • TxType, TxStatus (lightning/ledger.py), ChatRequest, ChatResponse, StatusResponse (timmy_serve/app.py)

Suggested Fix

Add one-line docstrings to each class explaining its purpose.

Acceptance Criteria

  • All 20 classes have docstrings
  • tox -e unit passes
## Problem 20 classes in `src/` are missing class-level docstrings: **dashboard/models/calm.py** (4 classes): - `TaskState`, `TaskCertainty`, `Task`, `JournalEntry` **dashboard/** (3 classes): - `TokenPayload` (discord.py, telegram.py), `_EnumLike` (work_orders.py), `PeriodType` (scorecard_service.py) **infrastructure/** (3 classes): - `Message` (chat_store.py), `Notification` (push.py), `Intent` (voice/nlu.py) **timmy/** (4 classes): - `ApprovalItem` (approvals.py), `Briefing` (briefing.py), `MockLLMClient`, `MockCompletion` (research_tools.py) **Other** (3 classes): - `TxType`, `TxStatus` (lightning/ledger.py), `ChatRequest`, `ChatResponse`, `StatusResponse` (timmy_serve/app.py) ## Suggested Fix Add one-line docstrings to each class explaining its purpose. ## Acceptance Criteria - All 20 classes have docstrings - `tox -e unit` passes
Timmy commented 2026-03-23 18:24:45 +00:00
Author
Owner
Copy Link

@kimi

Task: Add one-line docstrings to 20 undocumented classes.

Files to modify:

  • src/dashboard/models/calm.py — TaskState, TaskCertainty, Task, JournalEntry
  • src/dashboard/routes/discord.py — TokenPayload
  • src/dashboard/routes/telegram.py — TokenPayload
  • src/dashboard/routes/work_orders.py — _EnumLike
  • src/dashboard/services/scorecard_service.py — PeriodType
  • src/infrastructure/chat_store.py — Message
  • src/infrastructure/notifications/push.py — Notification
  • src/integrations/voice/nlu.py — Intent
  • src/timmy/approvals.py — ApprovalItem
  • src/timmy/briefing.py — Briefing
  • src/timmy/research_tools.py — MockLLMClient, MockCompletion
  • src/lightning/ledger.py — TxType, TxStatus
  • src/timmy_serve/app.py — ChatRequest, ChatResponse, StatusResponse

What to do: Add a one-line class docstring explaining purpose. Read each class first.

Verify: tox -e unit passes, tox -e lint passes.

@kimi **Task:** Add one-line docstrings to 20 undocumented classes. **Files to modify:** - `src/dashboard/models/calm.py` — `TaskState`, `TaskCertainty`, `Task`, `JournalEntry` - `src/dashboard/routes/discord.py` — `TokenPayload` - `src/dashboard/routes/telegram.py` — `TokenPayload` - `src/dashboard/routes/work_orders.py` — `_EnumLike` - `src/dashboard/services/scorecard_service.py` — `PeriodType` - `src/infrastructure/chat_store.py` — `Message` - `src/infrastructure/notifications/push.py` — `Notification` - `src/integrations/voice/nlu.py` — `Intent` - `src/timmy/approvals.py` — `ApprovalItem` - `src/timmy/briefing.py` — `Briefing` - `src/timmy/research_tools.py` — `MockLLMClient`, `MockCompletion` - `src/lightning/ledger.py` — `TxType`, `TxStatus` - `src/timmy_serve/app.py` — `ChatRequest`, `ChatResponse`, `StatusResponse` **What to do:** Add a one-line class docstring explaining purpose. Read each class first. **Verify:** `tox -e unit` passes, `tox -e lint` passes.
kimi was assigned by Timmy 2026-03-23 18:24:46 +00:00
kimi was unassigned by Timmy 2026-03-23 20:01:50 +00:00
Timmy self-assigned this 2026-03-23 20:01:50 +00:00
Timmy closed this issue 2026-03-23 20:08:07 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
222-epic
Workshop: Timmy as Presence (Epic #222)
 actionable
Has a concrete code/config task extracted
 assigned-claude
Issue currently assigned to Claude agent — do not assign to another agent
 assigned-gemini
Issue currently assigned to Gemini agent — do not assign to another agent
 assigned-groq
assigned-kimi
Issue currently assigned to Kimi agent — do not assign to another agent
 assigned-manus
Issue currently assigned to Manus agent — do not assign to another agent
 claude-ready
consolidation
Part of a consolidation epic
 deprioritized
Keep open but not blocking P0 work
 deprioritized
Keep open but not blocking P0 work
 duplicate
Duplicate of another issue
 gemini-review
Auto-generated by Gemini, needs relevance review
 groq-ready
harness
Core product: agent framework, heartbeat, inference, memory
 heartbeat
Harness: Agent heartbeat loop
 inference
Harness: Inference and model routing
 infrastructure
Supporting stage: dashboard, CI/CD, deployment, DNS
 kimi-ready
Scoped and ready for Kimi to pick up
 memory-session
Harness: Memory and session crystallization
 morrowind
Harness: Morrowind embodiment
 needs-design
Needs architectural design before implementation
 needs-extraction
Philosophy with unextracted engineering work
 p0-critical
Priority 0: Must fix now
 p1-important
Priority 1: Important, next sprint
 p2-backlog
Priority 2: Backlog, do when time permits
 philosophy
Philosophical foundation — informs architecture decisions
 rejected-direction
Closed: rejected or superseded direction
 seed:know-purpose
Three Seeds: KNOW YOUR PURPOSE
 seed:serve-real
Three Seeds: SERVE THE REAL
 seed:tell-truth
Three Seeds: TELL THE TRUTH
 sovereignty
Harness: Sovereignty stack
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Timmy claude grok kimi manus perplexity Rockachopa
No Assignees Timmy
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Rockachopa/Timmy-time-dashboard#1130
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?