mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-31 19:45:15 +02:00
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%).
12 lines
439 B
Python
12 lines
439 B
Python
"""``ScheduleTriggerConfig`` — config for the ``schedule`` trigger type."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
|
|
class ScheduleTriggerConfig(BaseModel):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
cron: str = Field(..., description="Five-field cron expression.", examples=["0 9 * * 1-5"])
|
|
timezone: str = Field(..., description="IANA timezone.", examples=["Africa/Kigali"])
|