Drop the em dashes from the README - #31
Merged
Merged
Conversation
Seven of them, all doing work a comma, a colon or a full stop does better. The 73 hyphens stay: they are inside flags (`--json`), node ids (`hyp-self-consistency`) and compound words, where they are part of the token rather than punctuation. One rewrite broke the graph.yaml example and the doc tests caught it: replacing an em dash with a colon inside an unquoted YAML value is a second mapping separator, so `question: what this graph exists to answer: a question...` no longer parses. That is the whole argument for keeping the README's examples executable, demonstrated on a one-character edit.
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.
Seven em dashes removed, each replaced by the comma, colon or full stop that was doing the
work anyway.
The 73 hyphens stay: they sit inside flags (
--json), node ids (hyp-self-consistency)and compound words, where they are part of the token rather than punctuation.
One rewrite broke the example and the doc tests caught it. Swapping an em dash for a
colon inside an unquoted YAML value creates a second mapping separator:
That is the argument for keeping the README's examples executable, demonstrated on a
one-character edit.
284 passed.