Converts a CoverageReport’s undocumented entities into Findings.

Returns:

One Finding (rule_id “undocumented-entity”) per entity in report.entities

Methods

coverage_report_to_findings

coverage_report_to_findings(report: CoverageReport) -> List[Finding]

Converts a CoverageReport’s undocumented entities into Findings.

Returns:

One Finding (rule_id “undocumented-entity”) per entity in report.entities

ParameterTypeDescription
reportCoverageReportThe computed documentation coverage report.

Generated with Flude

Copyright © 2026