tooling: comments name the trap, not the story - #4
Merged
Conversation
A comment earns its place by naming the one non-obvious thing a future
editor would get wrong there. Provenance, history, and narration of what
the code plainly does go; rationale that guards against a wrong edit
stays.
The Justfile header takes the current scaffold wording, and the note
above `test` keeps the one fact that matters: brew is hidden by the
hermetic PATH and reaches the recipe as BREW_BIN. renovate.json5 keeps
what the aqua preset does beyond aqua.yaml, and why the go_install pins
need their own manager, in four lines. install.sh loses the step
narration ("Copy the run script", "Copy plist", the launchctl spelling
asides); the system-agent note, which names a real trap, stays. test.sh
loses "Linting" and the system-agent explanation that install.sh and the
README already carry. farcloser-ssh-agent loses "Traces of brew", the
dead-socket and foreground narration, and states the ~/.ssh/agent
file-versus-directory rule without its history. lib/utils.sh drops the
"Helpers" header and the dated TLS 1.3 claim; the retry rationale stays.
Files: Justfile, renovate.json5, install.sh, test.sh, farcloser-ssh-agent,
lib/utils.sh.
Signed-off-by: closer-claudio <claudio@farcloser.world>
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
2 participants
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.
Comment sweep of the project-owned tooling files: a comment names the one non-obvious thing a future editor would get wrong there; provenance, history and narration of what the code plainly does are gone; rationale that guards a wrong edit stays. Comments only, plus the README change named in the title where there is one.
just lintgreen locally;just test(a brew tap/install) cannot run in the sandbox, CI is the proof.