Computes documentation coverage over the real catalog shape.
Counts each class (by fully_qualified_name), its methods, and its
fields (variables). Enums, constants, and type_aliases on ClassModel
are not yet counted; extending coverage to them follows the exact same
pattern as the loops below.
Private (_foo), dunder (__foo__), and logger entities are excluded
from the registry entirely – see _is_excluded_from_coverage.
Returns:
A CoverageReport summarizing total/documented entity counts,
Methods
compute_coverage
compute_coverage(catalog: ProjectCatalog) -> CoverageReport
Computes documentation coverage over the real catalog shape.
Counts each class (by fully_qualified_name), its methods, and its
fields (variables). Enums, constants, and type_aliases on ClassModel
are not yet counted; extending coverage to them follows the exact same
pattern as the loops below.
Private (_foo), dunder (__foo__), and logger entities are excluded
from the registry entirely – see _is_excluded_from_coverage.
Returns:
A CoverageReport summarizing total/documented entity counts,
| Parameter | Type | Description |
|---|---|---|
| catalog | ProjectCatalog | The parsed project catalog to compute coverage over. |
Generated with Flude
Copyright © 2026