Rewrite README prose in plain technical style - #31
Merged
Conversation
The README mixed technical description with marketing register: em
dashes, staged short sentences, and idiom ("baked-in defaults",
"flipping the switch", "clobbered") that read as copy rather than
documentation.
This commit replaces the em dashes with commas, a colon, and a sentence
break; collapses the Dependabot/Renovate framing into a single factual
sentence; and swaps the idiomatic phrasing for direct wording. Line
wrapping matches the file's existing width.
No content or behavior described in the README changed, so the
documented configuration and safety properties are unaffected.
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.
What changed
Five prose edits to
README.md. No content, configuration, or documentedbehavior changed.
sentence break.
Neither does Renovate. This action fills that gap." sequence into one
factual sentence.
"flipping the switch", italicized
_would_) with direct description.its own.
Why
The README mixed technical description with marketing register. These edits
bring it in line with a plain technical documentation style.
Notes for reviewers
Line wrapping matches the file's existing width, so the diff is larger than
the wording changes alone. The config examples, grouping-strategy
descriptions, and safety-properties list are untouched apart from the
wording noted above.