chore(automation): trim docstrings to intent only

Cut the docstrings and Field(description=...) text across the entire
automations/ tree down to single-line intent statements, matching the
multi_agent_chat conciseness style:

- Module docstrings: one line stating what the file is.
- Class docstrings: deleted when the class name + module docstring
  already cover intent; kept only where they add a constraint or
  rationale not visible in the signature.
- Pydantic Field descriptions: short noun phrases / clauses, not
  full sentences. Reasoning that belonged in the design plan moved
  out of the code.
- Enum values: per-value docstrings replaced with terse inline
  comments where the meaning isn't obvious from the name.

Behaviour is unchanged. The same 33 files, same public surface, same
imports — verified by re-running the 10-point registry smoke test and
the 8-point schema round-trip / constraint suite from commits 9 and
10.

LOC: 1180 → 691 (-42%).
This commit is contained in:
CREDO23 2026-05-26 23:01:22 +02:00
parent 7a96c0e29c
commit f0e00bd3ee
33 changed files with 80 additions and 568 deletions

View file

@ -1,4 +1,4 @@
"""SQLAlchemy / Python enums backing the three automation tables."""
"""Enums for the automation tables."""
from __future__ import annotations

View file

@ -1,4 +1,4 @@
"""``AutomationStatus`` — lifecycle of a stored automation definition."""
"""Automation lifecycle status."""
from __future__ import annotations
@ -6,13 +6,6 @@ from enum import StrEnum
class AutomationStatus(StrEnum):
"""Status of an automation in the registry.
``active`` eligible to fire from its triggers.
``paused`` definition retained, triggers do not fire.
``archived`` kept for run history only; no edits, no fires.
"""
ACTIVE = "active"
PAUSED = "paused"
ARCHIVED = "archived"
ACTIVE = "active" # eligible to fire
PAUSED = "paused" # kept, but triggers don't fire
ARCHIVED = "archived" # read-only history

View file

@ -1,4 +1,4 @@
"""``RunStatus`` — the state machine of a single ``AutomationRun``."""
"""AutomationRun state machine: pending → running → (succeeded|failed|cancelled|timed_out)."""
from __future__ import annotations
@ -6,20 +6,6 @@ from enum import StrEnum
class RunStatus(StrEnum):
"""Lifecycle states of an ``AutomationRun`` row.
Transitions are linear with three terminal branches:
pending running (succeeded | failed | cancelled | timed_out)
``pending`` row created, executor task enqueued, work not started.
``running`` executor has picked up the run.
``succeeded`` terminal: plan completed without error.
``failed`` terminal: at least one step raised an unrecoverable error.
``cancelled`` terminal: caller asked for cancellation.
``timed_out`` terminal: run exceeded its configured timeout.
"""
PENDING = "pending"
RUNNING = "running"
SUCCEEDED = "succeeded"

View file

@ -1,4 +1,4 @@
"""``TriggerType`` — the trigger-kind discriminator (v1 = schedule, manual)."""
"""Trigger-kind discriminator. v1: schedule | manual; webhook/event in Phase 2/3."""
from __future__ import annotations
@ -6,16 +6,5 @@ from enum import StrEnum
class TriggerType(StrEnum):
"""Kind of trigger an ``AutomationTrigger`` row represents.
v1 ships two kinds:
``schedule`` fires on a cron expression managed by Celery Beat.
``manual`` fires on demand from the UI's "Run now" affordance.
``webhook`` and ``event`` are deferred to Phase 2 and Phase 3
respectively; adding them is an enum-value extension only.
"""
SCHEDULE = "schedule"
MANUAL = "manual"