Say what the code does now, not what it did before - #2
Merged
Conversation
A pass over every comment in this repository, on three rules. No hardcoded dates. A measurement's value is the number, not the day it was taken, and a date in a comment is a claim that ages without anyone checking it. The measurements stay; "Measured 2026-09-06 on lychee 0.24.2" becomes "measured on lychee 0.24.2". No past-state narration. A comment describing what the code used to do makes a reader reconstruct a version that no longer exists before reaching the one in front of them. Each of these is rewritten to state current behaviour and the reason for it, keeping the failure mode where it is what makes the reason legible. Shorter, without dropping anything load-bearing. Run-together blocks split, summary sentences moved to the front of the comment they summarise. Comment-only: every executable line in this diff is byte-identical to the one it replaces, verified by stripping comments from both sides and diffing.
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.
A pass over every comment in this repository, on three rules.
No hardcoded dates. A measurement's value is the number, not the day it was
taken, and a date in a comment is a claim that ages without anyone checking it.
The measurements stay.
No past-state narration. A comment describing what the code used to do makes
a reader reconstruct a version that no longer exists before reaching the one in
front of them. Each is rewritten to state current behaviour and the reason for
it, keeping the failure mode where that is what makes the reason legible.
Shorter, without dropping anything load-bearing.
Comment-only: every executable line in this diff is byte-identical to the one it
replaces, verified by stripping comments from both sides and diffing.