docs: take the em-dashes out of the README - #58
Merged
Conversation
Sixty-two of them, in a file a judge reads before anything else. The house style avoids them because they stack clauses into sentences that are hard to read aloud. Substitution was not blind. A parenthetical pair becomes a pair of commas, an em-dash introducing an independent clause becomes a full stop so the sentence ends instead of growing, and the rest become commas where an appositive reads naturally. The title takes a colon, since a comma made it read as a list. Checked afterwards for the artefacts this kind of edit produces: no double commas, no stranded punctuation, no heading left ending mid-clause.
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 README had 62 em-dashes in 682 lines, in the file a judge opens before anything else. House style avoids them: they stack clauses into sentences that are hard to read aloud.
Not a blind find-and-replace
A mechanical swap to commas produces comma splices, so the pass distinguishes three cases:
A — B — C(parenthetical pair)A, B, C—before an independent clause.,The title took a colon rather than a comma, because
# Cinemory, your memories, made into filmreads as a list.Checked afterwards
Scanned for the artefacts this edit produces: zero double commas, stranded punctuation, or headings left ending mid-clause. The only line matching the heading check is a code comment inside a fenced block, not prose.
Docs only. No application code, no video, no demo asset.