mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-31 19:45:15 +02:00
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:
parent
7a96c0e29c
commit
f0e00bd3ee
33 changed files with 80 additions and 568 deletions
|
|
@ -1,4 +1,4 @@
|
|||
"""``InputsBlock`` — the ``inputs`` section of the automation definition."""
|
||||
"""``InputsBlock`` — JSON Schema for inputs an automation accepts at fire time."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
|
|
@ -8,23 +8,6 @@ from pydantic import BaseModel, ConfigDict, Field
|
|||
|
||||
|
||||
class InputsBlock(BaseModel):
|
||||
"""The ``inputs`` block of an ``AutomationDefinition``.
|
||||
|
||||
Holds a JSON Schema describing what data the automation accepts at
|
||||
fire time. The same schema is used by:
|
||||
|
||||
- The form editor (to render the manual-run dialog).
|
||||
- The dispatcher (to validate trigger payloads before enqueueing
|
||||
executor work).
|
||||
- The template engine (to expose ``{{ inputs.* }}`` references in
|
||||
plan-step configs).
|
||||
|
||||
The ``schema`` value is the JSON-Schema dict itself, not a
|
||||
Pydantic model — automations express their input contract in pure
|
||||
JSON Schema so it round-trips losslessly through the database and
|
||||
the NL generator.
|
||||
"""
|
||||
|
||||
model_config = ConfigDict(
|
||||
extra="forbid",
|
||||
populate_by_name=True,
|
||||
|
|
@ -34,10 +17,5 @@ class InputsBlock(BaseModel):
|
|||
schema_: dict[str, Any] = Field(
|
||||
...,
|
||||
alias="schema",
|
||||
description=(
|
||||
"JSON Schema (draft-07 compatible) describing the inputs "
|
||||
"this automation accepts. Properties may use the special "
|
||||
"``$last_fired_at`` default literal to bind to the "
|
||||
"trigger's last fire time."
|
||||
),
|
||||
description="JSON Schema (draft-07) for accepted inputs.",
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue