Skip to content

Commit 950a15d

Browse files
navidshadclaude
andcommitted
docs: clarify multi-line comments are allowed (no "one short line" rule)
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ff2935c commit 950a15d

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ Implications:
6060
- **Asset URLs need `web_accessible_resources`.** `chrome.runtime.getURL("/assets/foo.png")` returns `chrome-extension://invalid/` for paths not declared accessible. The manifest already exposes `assets/*` to all URLs.
6161
- Webpack entry points live in [webpack.config.js](webpack.config.js) — add a new entry there for any new content script.
6262

63+
## Code comments
64+
65+
Multi-line comments and docstrings are fine — encouraged, even, where the *why* is non-obvious (ESM init-order traps, cross-bundle behaviour, browser/extension quirks). Match the surrounding style (`navigation.ts`, `modular-rest.ts`, the `word-detail` JSDoc). There is **no** "one short line max" rule; don't collapse an explanatory block to a single line just to be terse.
66+
6367
## Shared APIs
6468

6569
### ConsoleCrane bridge

0 commit comments

Comments
 (0)