documentation
etl_craft.services.documentation ¶
Task documentation and its versions.
A task's DOCUMENTATION parameter holds its prose. docs-version records a new version in
AUD_TASK_DOCUMENTATION whenever the text has changed since the last one, told apart by a hash
of the text with surrounding whitespace removed, so the version cannot drift from the text the
way a hand-set number would.
DocumentationVersion
dataclass
¶
A documented task's current version, and whether this call recorded it.
documentation_hash ¶
Hash documentation text; whitespace around it does not count as a change.
refresh_versions ¶
Return every documented task's version, recording a new one where the text changed.
Without record nothing is written, and a changed text reports its next version.