Files
cozystack/docs
Timofei Larkin c55c3928cb docs(agents): reword the section-banner comment rule
The rule is meant to reject a comment that only names the code below it
and adds nothing, such as a heading over a ClusterRole whose kind and
name already say what it is. "Banners a section" reads instead as an
objection to decoration, so it gets applied to the shape: `# == view
role ==` is rejected while `# view role`, which says exactly as little,
passes, and a heading that does orient the reader in a long file can be
rejected for its `==`.

Both places the rule appears, the in-code comments blocker and the list
of machine-authorship tells, now describe the content that is wrong
rather than its formatting. What the rules enforce is unchanged.

Assisted-by: LLM
Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
2026-11-16 13:28:17 +01:00
..
2026-11-13 12:57:32 +00:00