The two ends of one report disagreed about the same files - #28
Merged
Conversation
The header asks `likeliest_docs_directory` whether anything unread is NAMED like documentation, and prints either a widen suggestion or "none of them is named like a documentation tree". The verdict then called every one of those files "documentation file(s)" and divided by them. On `zhukunpenglinyutong/desktop-cc-gui` the same run says, forty lines apart, that none of the 5,812 unread files looks like documentation and that the verdict "covers 1% of the documentation in this project". 5,271 of them are an OpenSpec change-proposal tree, which nobody would want checked against HEAD. Measured over 39 sweep captures, 24 with a coverage line: 1% to 99%, median 27.5%, seven under 10%. A directory named like documentation was found unread in 4 of the 24 - so in twenty cases the tool divided by a denominator it had itself just judged to hold no documentation. One of the fourteen commonest biggest-unread directories is documentation; the rest are skills/, src/, .agents/, crates/, libs/, ts/, tools/, mobile/, examples/, benchmarks/. The percentage STAYS. A narrow pass must never read as a clean one and that is the entire reason this line exists. What goes is the assertion about what those files are. And when something unread IS a documentation tree the verdict now names it, instead of leaving the reader who only reads the last line to scroll up for it. 209 tests. Two rewritten to the new wording and one new, covering the branch the change exists for.
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.
The header asks
likeliest_docs_directorywhether anything unread is NAMED like documentation, and prints either a widen suggestion or "none of them is named like a documentation tree". The verdict at the bottom then called every one of those files "documentation file(s)" and divided by them.On
zhukunpenglinyutong/desktop-cc-guithe same run says, forty lines apart:5,271 of those are an OpenSpec change-proposal tree. Nobody would want them checked against HEAD, the tool has already said as much, and then it reports 1% coverage of "the documentation in this project".
Measured, because one repository is not a defect
39 sweep captures, 24 of which print a coverage line:
So in twenty of twenty-four cases the tool divided by a denominator it had itself just judged to contain no documentation tree.
The fourteen commonest biggest-unread directories, and exactly one is documentation:
Per-package READMEs and agent instruction files, which
find_docsexcludes on purpose and whose docstring argues why.What changes and what does not
The percentage stays. A narrow pass must never read as a clean one, which is the entire reason this line exists - the README promises "a clean report over two files in a project with three hundred cannot be mistaken for a clean report over three hundred" and printing it forty lines from the verdict is how it got mistaken in the first place.
What goes is the assertion about what those files are:
And the other branch, which is the one the change exists for - when something unread really is a documentation tree, the last line says so rather than making the reader scroll:
report_coveragenow returns the directory it computed instead of throwing it away, and the verdict carries the same judgement the header already made.209 tests. Two rewritten to the new wording, one new for the docs-tree branch, and the new one also asserts the header still prints the actionable
--docsform, so the two ends are checked together.