Private (_foo), dunder (__foo__), and logger-instance names are
parser/tooling artifacts (e.g. namespace-level variable/import wrappers
synthesized by the Doxygen collector), not public API surface – forcing
docstrings on them is a false positive, not a real documentation gap.
Returns:
True if the entity should be excluded from the coverage registry.
Methods
_is_excluded_from_coverage
_is_excluded_from_coverage(name: str) -> bool
Private (_foo), dunder (__foo__), and logger-instance names are
parser/tooling artifacts (e.g. namespace-level variable/import wrappers
synthesized by the Doxygen collector), not public API surface – forcing
docstrings on them is a false positive, not a real documentation gap.
Returns:
True if the entity should be excluded from the coverage registry.
| Parameter | Type | Description |
|---|---|---|
| name | str | The entity’s short (non-qualified) name. |
Generated with Flude
Copyright © 2026