From 7399d554ecb8032a1e57f593338330399e6eb6d2 Mon Sep 17 00:00:00 2001 From: Serkyo Date: Sat, 16 May 2026 20:29:51 +0200 Subject: [PATCH] docs(workspace): require comments stay on one line when possible --- AGENTS.md | 1 + CLAUDE.md | 1 + 2 files changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 8c41485..c75a1a7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -137,6 +137,7 @@ The game is **multithreaded by design** — single-threaded would not meet the p - **Focus:** Describe the code's behavior, the system's state, or technical invariants. - **Struct Documentation:** Every field in a public or internal struct must have a doc comment (`///`) explaining its purpose and any invariants. - **Stability:** Treat the documentation as a technical specification for the engine. +- **Line breaks:** Do not insert line returns inside a comment unless necessary. A comment that fits on a single line stays on a single line — do not pre-wrap at ~80 chars for aesthetics. Only break across lines when the comment is genuinely long (multi-sentence prose, enumerated invariants) or when a hard break carries meaning (separating an intro line from a bullet list, for instance). ## Target platforms diff --git a/CLAUDE.md b/CLAUDE.md index 12f29db..939038d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -137,6 +137,7 @@ The game is **multithreaded by design** — single-threaded would not meet the p - **Focus:** Describe the code's behavior, the system's state, or technical invariants. - **Struct Documentation:** Every field in a public or internal struct must have a doc comment (`///`) explaining its purpose and any invariants. - **Stability:** Treat the documentation as a technical specification for the engine. +- **Line breaks:** Do not insert line returns inside a comment unless necessary. A comment that fits on a single line stays on a single line — do not pre-wrap at ~80 chars for aesthetics. Only break across lines when the comment is genuinely long (multi-sentence prose, enumerated invariants) or when a hard break carries meaning (separating an intro line from a bullet list, for instance). ## Target platforms