code-comments: allow a contiguous comment header block at the top of every file #198

New issue

Closed

opened 2026-06-08 20:22:07 +00:00 by coilysiren · 0 comments

coilysiren commented

2026-06-08 20:22:07 +00:00

Owner

The code-comments hook (agentic_os/check_code_comments.py) previously allowed
YAML only a single comment on line 1, and code comments anywhere up to two
contiguous lines with no header allowance.

Relax both into one unified rule:

Every file may carry a contiguous comment header block above the first
content line, of any length (each line still capped at 90 chars). Shebang and
encoding lines count as preamble, so the header block may follow them.
After content begins, code allows up to two contiguous comment lines; YAML
allows none (a key-sorter would drift any later comment off its target).

This lets license and teaching headers sit at the top of any file while keeping
inline comments short and non-contiguous.

Follow-up to #159 / #160.

The code-comments hook (`agentic_os/check_code_comments.py`) previously allowed YAML only a single comment on line 1, and code comments anywhere up to two contiguous lines with no header allowance. Relax both into one unified rule: - Every file may carry a contiguous comment header block above the first content line, of any length (each line still capped at 90 chars). Shebang and encoding lines count as preamble, so the header block may follow them. - After content begins, code allows up to two contiguous comment lines; YAML allows none (a key-sorter would drift any later comment off its target). This lets license and teaching headers sit at the top of any file while keeping inline comments short and non-contiguous. Follow-up to #159 / #160.

coilysiren referenced this issue from a commit

2026-06-08 20:23:26 +00:00

feat(code-comments): allow a contiguous comment header block at the top of every file

coilysiren closed this issue

2026-06-08 20:23:26 +00:00