learnings: docstrings describe statement, not proof#10
Open
CBirkbeck wants to merge 1 commit into
Open
Conversation
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
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.
Community Teaching Contribution
Entry
Before / After
Why this matters for /cleanup
The proof-decomposer and sorry-filler agents sometimes generate docstrings that summarise the proof technique. Adding this to the Phase-2 style audit (docstring presence/quality check) would flag and strip these.
Module docstrings (the top-of-file
/-! ... -/blocks) CAN describe overall proof strategy for the file — only per-lemma docstrings are subject to this rule.Auto-contributed by mathlib-quality `/teach` command.