Repository navigation
feat: Phase J J3 docs coverage report -- AST-based module docstring scanner, DocsCoverageReport, format_docs_coverage_report, 63 tests - #907
Merged
Conversation
…canner, DocsCoverageReport, format_docs_coverage_report, 63 tests (#907)
cschanhniem
added a commit
that referenced
this pull request
Jul 10, 2026
…canner, DocsCoverageReport, format_docs_coverage_report, 63 tests (#907)
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.
Implements J3 from NEXT_100_PR_MAP: docs coverage report.
What
docs_coverage.py: AST-based module docstring scannercheck_docs_coverage(source_dir)→ DocsCoverageReport with total/covered/uncovered counts_has_module_docstring(path): parses AST, gracefully handles SyntaxError_extract_module_name(path, source_dir): converts file path to dotted module nameformat_docs_coverage_report(report): human-readable with Documented/Undocumented sectionsexclude_initflag to skip init.py filesWhy
Shows what is and isn't documented. Undocumented modules are invisible to agents.
Disconfirming pass