test: demonstrate insufficiently commented tests#13221
Merged
rgrinberg merged 2 commits intoocaml:mainfrom Jan 7, 2026
Merged
Conversation
rgrinberg
force-pushed
the
push-tuzuutxxslkt
branch
2 times, most recently
from
9e769d5 to
2f97ccc
Compare
Signed-off-by: Rudi Grinberg <me@rgrinberg.com>
rgrinberg
force-pushed
the
push-tuzuutxxslkt
branch
from
2f97ccc to
3d5752d
Compare
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
1 participant
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.
Ideally, all tests should have comments describing what they're testing. Some old tests do not fulfill this criteria, this rule makes note of them by writing them all in a file. We should not grow this file, but shrink it over time by filling in the missing descriptions.