touch up grammar, punctuation, and Markdown #644
Merged
Conversation
This file contains 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
I haven't gone through the whole README, but I found a number of things that could be improved. Although "for" was sometimes used like this in archaic forms of English (Middle English? Early Modern?) it is not used in current Modern English (and I think it was always "for to" back when it _was_ used—I don't remember). In regard to code fences, it does appear that GitHub allows the language identifier to have a space before it (and after the 3 backticks) but their guide shows it without a space, and I'm not sure whether other Markdown parsers would allow that space (which I've never seen before). If you really like the space I can modify the PR to add them back, but I think it's much safer to do without them. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting
|
@brandondrew Thank you! |
Merged
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.
I haven't gone through the whole README, but I found a number of things that could be improved.
Although "for" was sometimes used like this in archaic forms of English (Middle English? Early Modern?) it is not used in current Modern English (and I think it was always "for to" back when it was used—I don't remember).
In regard to code fences, it does appear that GitHub allows the language identifier to have a space before it (and after the 3 backticks) but their guide shows it without a space, and I'm not sure whether other Markdown parsers would allow that space (which I've never seen before). If you really like the space I can modify the PR to add them back, but I think it's much safer to do without them.
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting