Improved punctuation, capitalization, and sentence structure of code snippet comments #37755
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @GuillaumeGomez (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. |
| @@ -11,7 +11,7 @@ this: | |||
| trait Graph<N, E> { | |||
| fn has_edge(&self, &N, &N) -> bool; | |||
| fn edges(&self, &N) -> Vec<E>; | |||
| // etc | |||
| // Etc. | |||
There was a problem hiding this comment.
Well, since et cetera means there are other things, let's write "Etc..." instead of just "Etc." ;)
There was a problem hiding this comment.
"etc." and "..." both indicate a continuation of a list, so it seems redundant to have both.
| @@ -36,7 +36,7 @@ trait Graph { | |||
|
|
|||
| fn has_edge(&self, &Self::N, &Self::N) -> bool; | |||
| fn edges(&self, &Self::N) -> Vec<Self::E>; | |||
| // etc | |||
| // Etc. | |||
| @@ -38,7 +38,7 @@ so as to avoid copying a large data structure. For example: | |||
| struct BigStruct { | |||
| one: i32, | |||
| two: i32, | |||
| // etc | |||
| // Etc. | |||
| @@ -68,7 +68,7 @@ This is an antipattern in Rust. Instead, write this: | |||
| struct BigStruct { | |||
| one: i32, | |||
| two: i32, | |||
| // etc | |||
| // Etc. | |||
|
Thanks a lot for all this! Just a little change needed and we're good to go. |
|
Thanks! @bors: r+ rollup |
|
📌 Commit 28548db has been approved by |
|
⌛ Testing commit 28548db with merge 766f6e4... |
Improved punctuation, capitalization, and sentence structure of code snippet comments r? @GuillaumeGomez
r? @GuillaumeGomez