compute_doc_quality_findings function

Walks catalog for low-quality docstrings and undocumented method parameters.

Mirrors ude.coverage.compute_coverage()’s traversal (class, its methods, its fields) and exclusion rules (_is_excluded_from_coverage, _PHANTOM_ARTIFACT_FQNS), so the same entities are in scope for both. docstring") per documented class/ method/field whose docstring is a stub or a name restatement, plus one Finding (rule_id “missing-param-doc”) per parameter missing a description on a method that otherwise is documented – a fully undocumented method’s parameters are not reported here, since DEL-B08’s undocumented-entity finding already covers that method.

Returns:

One Finding (rule_id “low-quality-

Methods

compute_doc_quality_findings

compute_doc_quality_findings(catalog: ProjectCatalog) -> List[Finding]

Walks catalog for low-quality docstrings and undocumented method parameters.

Mirrors ude.coverage.compute_coverage()’s traversal (class, its methods, its fields) and exclusion rules (_is_excluded_from_coverage, _PHANTOM_ARTIFACT_FQNS), so the same entities are in scope for both. docstring”) per documented class/ method/field whose docstring is a stub or a name restatement, plus one Finding (rule_id “missing-param-doc”) per parameter missing a description on a method that otherwise is documented – a fully undocumented method’s parameters are not reported here, since DEL-B08’s undocumented-entity finding already covers that method.

Returns:

One Finding (rule_id “low-quality-

Generated with Flude

Copyright © 2026