Synvael/synvael
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs(workspace): require comments stay on one line when possible

Browse source
This commit is contained in:
Serkyo 2026-05-16 20:29:51 +02:00
parent f968299f24
commit 7399d554ec
2 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
AGENTS.md
View file

@ -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. - **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. - **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. - **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 ## Target platforms

1
CLAUDE.md
View file

@ -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. - **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. - **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. - **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 ## Target platforms