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 @@
"""``AutomationRun`` table — the immutable per-fire execution record."""
"""``automation_runs`` table — immutable per-fire execution record."""
from __future__ import annotations
@ -18,16 +18,6 @@ from ..enums.run_status import RunStatus
class AutomationRun(BaseModel, TimestampMixin):
"""One execution of an automation.
Every fire of any trigger inserts exactly one row here. The row is
immutable from the user's perspective — the executor only updates
``status``, ``step_results``, ``output``, ``artifacts``, ``error``,
``started_at``, ``finished_at`` as the run progresses; the
``definition_snapshot`` is locked at fire time so the user can always
see exactly what code path executed for any historical run.
"""
__tablename__ = "automation_runs"
automation_id = Column(
@ -52,18 +42,14 @@ class AutomationRun(BaseModel, TimestampMixin):
index=True,
)
# locked at fire time so historical runs always show the exact code path
definition_snapshot = Column(JSONB, nullable=False)
trigger_payload = Column(JSONB, nullable=True)
resolved_inputs = Column(JSONB, nullable=False, server_default="{}")
step_results = Column(JSONB, nullable=False, server_default="[]")
output = Column(JSONB, nullable=True)
artifacts = Column(JSONB, nullable=False, server_default="[]")
error = Column(JSONB, nullable=True)
started_at = Column(TIMESTAMP(timezone=True), nullable=True)