SurfSense/surfsense_backend/app/automations/schemas/definition/metadata.py
CREDO23 f0e00bd3ee 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%).
2026-05-26 23:01:22 +02:00

14 lines
419 B
Python

"""``MetadataBlock`` — free-form metadata on a definition. Extra keys allowed."""
from __future__ import annotations
from pydantic import BaseModel, ConfigDict, Field
class MetadataBlock(BaseModel):
model_config = ConfigDict(extra="allow")
tags: list[str] = Field(default_factory=list)
created_from_nl: bool = Field(
default=False, description="True when produced by the NL generator."
)