[loop-generated] [refactor] Add docstrings to calm.py route handlers #569

Closed
opened 2026-03-20 01:25:51 +00:00 by Timmy · 1 comment
Owner

File: src/dashboard/routes/calm.py

Multiple public route handlers (20+ lines each) lack docstrings:

  • post_morning_ritual (75 lines)
  • reorder_tasks (45 lines)
  • promote_tasks (34 lines)
  • start_task (31 lines)
  • post_evening_ritual (30 lines)
  • defer_task (25 lines)
  • complete_task (25 lines)
  • create_new_task (24 lines)

Each needs a brief docstring explaining what it does, expected form data, and response type.

Acceptance: tox -e lint green, every public function has a docstring.

**File:** `src/dashboard/routes/calm.py` Multiple public route handlers (20+ lines each) lack docstrings: - `post_morning_ritual` (75 lines) - `reorder_tasks` (45 lines) - `promote_tasks` (34 lines) - `start_task` (31 lines) - `post_evening_ritual` (30 lines) - `defer_task` (25 lines) - `complete_task` (25 lines) - `create_new_task` (24 lines) Each needs a brief docstring explaining what it does, expected form data, and response type. Acceptance: `tox -e lint` green, every public function has a docstring.
Author
Owner

@kimi Instructions:

File: src/dashboard/routes/calm.py

Add docstrings to these public route handlers:

  • post_morning_ritual — POST handler for morning ritual form submission
  • reorder_tasks — POST handler to reorder task priorities
  • promote_tasks — POST handler to promote tasks to higher priority
  • start_task — POST handler to mark a task as started
  • post_evening_ritual — POST handler for evening ritual form submission
  • defer_task — POST handler to defer a task to a future date
  • complete_task — POST handler to mark a task as completed
  • create_new_task — POST handler to create a new task

Each docstring should include:

  1. One-line summary of what the handler does
  2. Brief description of expected form data
  3. Return type (HTMLResponse redirect or template render)

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

@kimi Instructions: **File:** `src/dashboard/routes/calm.py` Add docstrings to these public route handlers: - `post_morning_ritual` — POST handler for morning ritual form submission - `reorder_tasks` — POST handler to reorder task priorities - `promote_tasks` — POST handler to promote tasks to higher priority - `start_task` — POST handler to mark a task as started - `post_evening_ritual` — POST handler for evening ritual form submission - `defer_task` — POST handler to defer a task to a future date - `complete_task` — POST handler to mark a task as completed - `create_new_task` — POST handler to create a new task Each docstring should include: 1. One-line summary of what the handler does 2. Brief description of expected form data 3. Return type (HTMLResponse redirect or template render) Verify: `tox -e lint` passes, `tox -e unit` passes.
kimi was assigned by Timmy 2026-03-20 01:26:11 +00:00
Timmy closed this issue 2026-03-20 15:26:20 +00:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Rockachopa/Timmy-time-dashboard#569