Repository navigation
docs: thin the commentary back to what the code does not say - #9
Merged
Merged
Conversation
The comments had drifted from explaining the code to arguing with the alternatives: a quarter of every file, most of it a paragraph on why each private constant is not some other number. That is a tax on reading, and the second paragraph of such a block is almost never the one somebody needed. 448 comment lines go. The rule was: a private item keeps its summary line and loses the essay; a test keeps its name, which is a sentence already, and loses the doc that restated it. Nothing public lost a line — `deny(missing_docs)` is the floor — and nothing citing a Blue Book section, a field convention or a recorded trap was touched. Three blocks were put back condensed after the sweep, because they carried facts and not opinions: the accepted source URL forms, which io::ErrorKinds are transient on which source, and what 1115 and 1279 actually measure. 536 tests, fmt and clippy clean.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The comments had drifted from explaining the code to arguing with the alternatives — a quarter of every file, most of it a paragraph on why each private constant is not some other number.
448 comment lines go. The rule:
deny(missing_docs)is the floor);Three blocks were restored condensed after the sweep, because they carried facts rather than opinions: the accepted source URL forms, which
io::ErrorKinds are transient on which source, and what 1115 and 1279 actually measure.Density across
crates/: 26% → 24%.536 tests, fmt and clippy clean.