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.
Returns:
True if doc_text has fewer than 3 words, or if its words (lowercased,
| Parameter | Type | Description |
|---|---|---|
| doc_text | str | The entity’s |
| entity_name | str |
Generated with Flude
Copyright © 2026