Drop tools docstrings that only re-spell the code #92
Loading…
Reference in a new issue
No description provided.
Delete branch "refactor/tools-comment-prune"
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?
Ruff already ignores D102/D103/D105/D107, so a one-line docstring on a method whose name and signature already say the same thing is pure noise. Removes those across
tools/frame_benchandtools/release/package.py.Delete-only: no behavioural change. Docstrings that cite a spec section, explain a non-obvious rationale, or document a public CLI entry point are left alone.
tools/checkpasses (lint, format, mypy, pytest).Delete-only, single commit, scope stays inside
tools/frame_bench/*.pyandtools/release/package.py, and every removed docstring is a genuine restatement — none of them carried a spec citation, rationale or trap. Commit message is fine (imperative, one line, matches the repo's convention).A few one-line docstrings of exactly the same kind were left behind in the same files (not required, just noted since the branch is meant to sweep this pattern):
tools/frame_bench/sequences.py,Plan.span(~line 79):"""Give how long a whole play takes, in seconds."""— same wording pattern asStep.span's docstring a few lines above, which this PR does remove. Inconsistent to keep one and drop the other.tools/frame_bench/sequences.py,Player.__init__(~line 244):"""Take the bus to play on, and how to send and wait on it."""— just narrates the three constructor parameters (interface,sender,pause);__init__is D107, also ignored by ruff.tools/frame_bench/server.py,Bench.__init__(~line 85):"""Bind the server and remember which bus it publishes to."""— same situation, purely restates what the two lines below it do.tools/frame_bench/protocol.py,Message.describehad its docstring removed ("""Render the message as the browser's form definition."""), butFrameField.describe(~line 83) andprotocol.catalogue()(~line 1992) keep the identical phrasing ("Render ... as/for the browser's form definition"). Worth applying the rule the same way to all three rather than just the one.Nothing here blocks merging as-is — these are just the same prune missed in a few spots, for a follow-up pass if you want one.