Prune redundant docstrings in custom_components/campervan #102
Loading…
Reference in a new issue
No description provided.
Delete branch "chore/prune-restating-comments"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Delete-only pass over
custom_components/campervan/(includingprotocol/): removes one-line docstrings and attribute docstrings that only re-spell the name and signature next to them.Kept anything citing a spec section, explaining a sentinel/unit, or stating a non-obvious rationale or trap (for example
protocol/codec.py'sdecode/decode_wire,protocol/catalogue.py'sfind, and the override docstrings on_own_reading_arrived). Twoavailableproperties (switch.py,button.py) had their one-liner turned into a trailing comment since the reason was worth keeping.No behavioural change.
tools/checkpasses.Diff is exactly what it claims to be: docstring/comment deletions only, plus the two
availableproperties turned into#comments and the three trims (coordinator.py__init__, reading_store.py'snodes_heard/async_add_listener/async_add_node_listener). Nothing outsidecustom_components/campervan/touched, no renamed symbols, no logic changes.Spot-checked the deletions against the keep rules: no spec-section citations or sentinel/trap explanations were removed — those are all still present elsewhere (e.g.
reports_every's "Spec 9.4" comment,accepts_commands,is_complete,metadata_missing,label(),announce()). Didn't find the #100/#101 mistake (a spec-citing docstring wrongly deleted) repeated here.Two borderline calls, not blockers:
discovery.pyInventory.describe()/present()lost docstrings naming the wire frame (SYS_ENDPOINT_DESC/SYS_ENDPOINT_META) each records. That mapping isn't in the signature, only in the# From SYS_ENDPOINT_DESC./# From SYS_ENDPOINT_META.field comments onEndpointa few lines up — findable, but worth a glance if you want it explicit at the call site too.sensor.pyCampervanTrafficSensor.available's deleted docstring ("a run total does") is the same shape of "always available, and here's why" as the two cases kept as#comments in button.py/switch.py. I'd call it fine to drop sinceentity_description.run_totalnames itself, but flagging the inconsistency in treatment.Couldn't re-run
tools/check— the review worktree was removed partway through this session (environment issue on my end, unrelated to the PR). Correctness review here is from the diff/source only, not a fresh test run.Nothing here blocks merge; would approve if I weren't the PR's own author (Forgejo rejects self-approval).