A verifier that checked nothing must not be printed with a tick - #24
Merged
Conversation
Ran docproof cold on `rigout` and it said:
ok symbols: 0 checked
That is the sentence this tool exists to stop appearing anywhere. Its own README argues
"a checker that silently skips everything looks exactly like a clean one", and here it
was, three verifiers reporting real counts and the fourth reporting a tick over nothing.
It is NOT a bug in `Outcome.silent`, and the fix deliberately does not touch it. `symbols`
and `versions` set `silence_is_signal = False` on a measurement - twelve of forty
repositories document no own-package import, twenty document no Python requirement - so
their silence is ordinary and alarming on it would fail half a healthy corpus. That
decision stands. What was wrong was rendering an ordinary nothing as a pass.
It gets the dash now, the same marker an inapplicable verifier gets, because that is what
it is: nothing to say, said out loud.
200 tests.
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.
Ran docproof cold on a project it had never been pointed at:
The README argues against that last line in as many words: "a checker that silently skips everything looks exactly like a clean one."
Not a bug in
Outcome.silent, and this does not touch it.symbolsandversionssetsilence_is_signal = Falseon a measurement: twelve of forty repositories document no own-package import, twenty document no Python requirement, none of them broken. The classification is right; the rendering of it was not.One branch in
Report.render. An applicable verifier with nothing checked and nothing skipped gets the dash an inapplicable one already gets:Exit code, verdict and claim counts are unchanged.
tests/test_silence.pycovers it with a fixture where the verifier is applicable and empty, since an inapplicable one already prints a dash.200 tests.