Problem
The module docstring opens with """Multicast DNS Service Discovery for Python, v0.14-wmcbrine and the very next line is ) — a stray closing paren that belongs to nothing. It's clearly a copy-paste artifact from another file (the same header otherwise appears verbatim in every module in src/zeroconf/). It's syntactically harmless because it's inside a docstring, but it shows up in help(zeroconf._logger), in any auto-generated API docs, and in IDE hover-tooltips for the module.
Why This Matters
Pure cosmetic, but it's the first thing a reader sees when opening the file, and it makes the project look careless in generated docs. Trivial to fix and no risk.
Suggested Fix
Delete line 2 (the )). The remaining docstring matches the standard header used by sibling modules.
Details
|
|
| Severity |
🟢 Low |
| Category |
cleanup |
| Location |
src/zeroconf/_logger.py:1-2 |
| Effort |
⚡ Quick fix |
🤖 Created by Kōan from audit session
Problem
The module docstring opens with
"""Multicast DNS Service Discovery for Python, v0.14-wmcbrineand the very next line is)— a stray closing paren that belongs to nothing. It's clearly a copy-paste artifact from another file (the same header otherwise appears verbatim in every module insrc/zeroconf/). It's syntactically harmless because it's inside a docstring, but it shows up inhelp(zeroconf._logger), in any auto-generated API docs, and in IDE hover-tooltips for the module.Why This Matters
Pure cosmetic, but it's the first thing a reader sees when opening the file, and it makes the project look careless in generated docs. Trivial to fix and no risk.
Suggested Fix
Delete line 2 (the
)). The remaining docstring matches the standard header used by sibling modules.Details
src/zeroconf/_logger.py:1-2🤖 Created by Kōan from audit session