Functions

List of functions in the ude.doc_quality namespace.

Entity Name	Description
_split_identifier_words	Splits a camelCase/PascalCase/snake_case identifier into lowercase words.
_is_low_quality_docstring	Flags a docstring as a stub or a mechanical restatement of its entity’s own name. docstring text (only called when non-None/non-empty). entity_name: The entity’s own (short, non-qualified) name.
compute_doc_quality_findings	Walks `catalog` for low-quality docstrings and undocumented method parameters.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_is_low_quality_docstring function

Flags a docstring as a stub or a mechanical restatement of its entity’s own name. docstring text (only called when non-None/non-empty). entity_name: The entity’s own (short, non-qualified) name.

Returns:

True if doc_text has fewer than 3 words, or if its words (lowercased,

Methods

_is_low_quality_docstring

_is_low_quality_docstring(doc_text: str, entity_name: str) -> bool

Flags a docstring as a stub or a mechanical restatement of its entity’s own name. docstring text (only called when non-None/non-empty). entity_name: The entity’s own (short, non-qualified) name.

_split_identifier_words function

Splits a camelCase/PascalCase/snake_case identifier into lowercase words.

Returns:

The identifier’s words, lowercased, in order (e.g. “getVolume” and

Methods

_split_identifier_words

_split_identifier_words(identifier: str) -> List[str]

Splits a camelCase/PascalCase/snake_case identifier into lowercase words.

Returns:

The identifier’s words, lowercased, in order (e.g. “getVolume” and

Parameter	Type	Description
identifier	`str`	The identifier to split (e.g. a class or method name).

Generated with Flude

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.