Say the rule, not the process, in code comments - #224
Open
Pixnop wants to merge 1 commit into
Open
Conversation
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
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 sweep over comments that explained a file's placement by referring to the process that produced it rather than to the rule that governs it. A reader a year from now has the code and nothing else, so a comment pointing at work in flight or at a checklist step is worse than no comment at all.
Four comments carried a shorthand marker for a deliberate limitation. They now say "Known limit" and read the same otherwise. Two referred to work happening elsewhere at the time, one of them to a file that may not have existed yet on that branch; both now describe the boundary itself. Six spoke of a stage and its exit gate, which is process vocabulary for a rule that stands on its own: nothing under src/renderer/src/components may touch the preload bridge, and no file under features/mods may mention window.api. That is what they say now. Two test comments dated themselves against a stage rather than against the behaviour they pin.
No code changed, only comments, so the unchanged suite passing is the whole proof.