Update README #45
Update README #45
Conversation
README.md
Outdated
| In practice, it will act as a staging ground for some APIs that may eventually be incorporated into the Swift Standard Library, and when that happens such changes will be proposed to the Swift Standard Library using the established evolution process of the Swift project. | ||
|
|
||
| Swift Numerics uses github issues to track bugs and features, and pull requests for development. | ||
| Swift Numerics uses GitHub issues to track bugs and features and pull requests for development. |
There was a problem hiding this comment.
| Swift Numerics uses GitHub issues to track bugs and features and pull requests for development. | |
| Swift Numerics uses GitHub issues to track bugs and features, and pull requests for development. |
This comma delimiter is required for clarity.
There was a problem hiding this comment.
But ", and" is grammatically incorrect... Do you like this, it is both grammatically correct and easy to read:
Alternative 1 - Ampersand
"Swift Numerics uses GitHub issues to track bugs & features and pull requests for development."
Alternative 2 - Slash:
"Swift Numerics uses GitHub issues to track bugs/features and pull requests for development."
Alternative 3 - "or":
"Swift Numerics uses GitHub issues to track bugs or features and pull requests for development."
🤔
There was a problem hiding this comment.
Those are all bad.
Swift Numerics uses GitHub issues to track bugs and features. We use pull requests for development.
There was a problem hiding this comment.
But ", and" is grammatically incorrect...
FWIW, it is grammatically just fine here, whatever the tools try to tell you.
There was a problem hiding this comment.
@xwu It is the case of compound predicate, see screenshot:
There was a problem hiding this comment.
There's no second verb. Even in the case of a compound predicate, it's fine to use a comma when it's necessary for other reasons. You can ignore the tool.
|
Except for xiaodi's nit, this LGTM. Please take that fix and I'll merge. |
Formatting Grammar & punctuation Links
3 participants
Formatting
Grammar & punctuation
Links
This is the same PR as closed #33 (but in all my excitement I accidentally committed from my
master, branch, this PR is from a feature branch). I've rebased merged #34 onto my branch before applying the changes.All changes suggested by @xwu (in #33) has been applied here, except an incorrect comma.
In general, I would really like to recommend using amazing grammar and language precision tool Grammarly, which I used to find some room for improvement.