feat: missingDocs linter warns about empty doc strings#13188
Merged
wkrozowski merged 6 commits intoleanprover:masterfrom Mar 30, 2026
Merged
feat: missingDocs linter warns about empty doc strings#13188wkrozowski merged 6 commits intoleanprover:masterfrom
missingDocs linter warns about empty doc strings#13188wkrozowski merged 6 commits intoleanprover:masterfrom
Conversation
wkrozowski
changed the title
missingDocs linter now is now triggered by empty docstringsmissingDocs linter warns about empty doc strings
github-actions
bot
added
the
toolchain-available
|
Mathlib CI status (docs):
|
Collaborator
|
Reference manual CI status:
|
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
volodeyka
pushed a commit
that referenced
this pull request
Apr 16, 2026
This PR extends the `missingDocs` linter to detect and warn about empty doc strings (e.g. `/---/` or `/-- -/`), in addition to missing doc strings. Previously, an empty doc comment would silence the linter even though it provides no documentation value. Now empty doc strings produce a distinct "empty doc string for ..." warning, while `@[inherit_doc]` still suppresses warnings as before.
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
2 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 extends the
missingDocslinter to detect and warn about empty doc strings (e.g./---/or/-- -/), in addition to missing doc strings. Previously, an empty doc comment would silence the linter even though it provides no documentation value. Now empty doc strings produce a distinct "empty doc string for ..." warning, while@[inherit_doc]still suppresses warnings as before.