doc: guide Claude to write concise inline comments#14038
Open
kim-em wants to merge 1 commit into
Open
Conversation
This PR adds a `## Comments` section to the project `.claude/CLAUDE.md`, directing Claude Code to keep inline comments concise and reserve them for important, non-obvious facts about the code at hand. It discourages comments that restate the code or a general API contract, narrate prior or rejected behavior, or document API usage that belongs at the definition. Prompted by discussion on the lean-fro Zulip about Claude attaching long, path-dependent comments at unremarkable call sites. 🤖 Prepared with Claude Code
github-actions
Bot
added
the
toolchain-available
|
Mathlib CI status (docs):
|
Collaborator
|
Reference manual CI status:
|
Kha
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a
## Commentssection to the project.claude/CLAUDE.md, directing Claude Code to keep inline comments concise and reserve them for important, non-obvious facts about the code at hand. It discourages comments that restate the code or a general API contract, narrate prior or rejected behavior, or document API usage that belongs at the definition.Prompted by discussion on the lean-fro Zulip about Claude attaching long, path-dependent comments at unremarkable call sites.
🤖 Prepared with Claude Code