Rewrite paragraph in 'match' to be more concise and readable. Start #30502
Conversation
correcting use of ':' in sentences. The colon `:` should be used only when the sentence preceeding it is a complete sentence. If this is not the case, then a `;` should be used; this denotes that the following fragment is a part of the previous fragment.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
This is not standard American English usage of the semicolon, which separates independent clauses. |
| @@ -9,7 +9,7 @@ document your project. | |||
| The Rust distribution includes a tool, `rustdoc`, that generates documentation. | |||
| `rustdoc` is also used by Cargo through `cargo doc`. | |||
|
|
|||
| Documentation can be generated in two ways: from source code, and from | |||
| Documentation can be generated in two ways; from source code, and from | |||
There was a problem hiding this comment.
I disagree with this change, as the text preceding the colon introduces the text afterward, which cannot stand alone as a sentence.
There was a problem hiding this comment.
Yes, Me too. First of all, this is an independent clause, and is very commonly used like this, with a list.
There was a problem hiding this comment.
Yes, agreed. 👍 I read that one incorrectly.
|
Thank you for caring about grammar, @Luke-Nukem ! I'm not sure I agree with all of these changes, though it is late in the evening. Some of them are certainly improvements though. |
|
And thank you, @steveklabnik for writing the book in the first place; it is a commendable effort. 👍 |
|
@bors: r+ rollup |
|
📌 Commit 1522350 has been approved by |
Rewrite of a paragraph in in the `match` section. The colon `:` should be used only when the sentence preceeding it is a complete sentence. If this is not the case, then a `;` should be used; this denotes that the following fragment is a part of the previous fragment. I got a new bike; it has two wheels. (Similar to I got a new bike, it has two wheels) The ice cream truck has great flavours; blueberry, blackberry, berryberry. Writing a complete sentence: - with a list under it - You can join two sentences with it: Much like this. r? @steveklabnik
Rewrite of a paragraph in in the
matchsection.Correcting use of ':' in sentences.
The colon
:should be used only when the sentence preceeding it is acomplete sentence. If this is not the case, then a
;should be used;this denotes that the following fragment is a part of the previous
fragment.
Examples of
;use:I got a new bike; it has two wheels. (Similar to I got a new bike, it has two wheels)
The ice cream truck has great flavours; blueberry, blackberry, berryberry.
Examples of
:use:Writing a complete sentence:
r? @steveklabnik