Update README.md to ensure proper grammar and consistency with the rest of the list #9310
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
As per the University of Oxford style guide (https://www.ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf), oxford commas should only be used when it improves clarity, which one in this context does not. :)
|
why are these changes needed.................... |
They are not strictly needed to keep the project alive, however it would clean up some issues that are currently present in the readme. Basically just documentation changes. |
|
sus |
|
please don't make one-line readme change mrs |
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.
This pull request updates
README.mdto remove the oxford comma (the University of Oxford recommends this, as can be seen here. This is optional, though. If Vaxry wishes to keep the oxford comma, it is fine by me as it is defined by other bodies that an oxford comma is appropriate in this context. I have allowed edits by maintainers so that he can do this if he wishes.However, the first colon here is widely considered incorrect and should be updated to be a semicolon.
The other issue with the current readme is that it has a full stop one one specific line, which should be rectified for consistency. This PR also does this.
Depending on Vaxry's opinion on the oxford comma being used in this context, it may or may not be ready for merging.
Happy hypring!