-
Notifications
You must be signed in to change notification settings - Fork 13k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixing basic typos in Doc Comments #42812
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @pnkfelix (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. |
Thanks! @bors r+ rollup |
📌 Commit a21e056 has been approved by |
@@ -221,9 +221,9 @@ impl<'a> PanicInfo<'a> { | |||
/// | |||
/// panic::set_hook(Box::new(|panic_info| { | |||
/// if let Some(location) = panic_info.location() { | |||
/// println!("panic occured in file '{}' at line {}", location.file(), location.line()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is now a tidy violation on this line, it needs to be wrapped
tidy check (x86_64-unknown-linux-gnu)
tidy error: /checkout/src/libstd/panicking.rs:224: line longer than 100 chars
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now there's a new tidy error:
tidy error: /checkout/src/libstd/panicking.rs:224: trailing whitespace
You're going to need to remove that space at the end of this line
@bors r- |
src/libstd/panicking.rs
Outdated
@@ -221,7 +221,7 @@ impl<'a> PanicInfo<'a> { | |||
/// | |||
/// panic::set_hook(Box::new(|panic_info| { | |||
/// if let Some(location) = panic_info.location() { | |||
/// println!("panic occurred in file '{}' at line {}", location.file(), location.line()); | |||
/// println!("panic occurred in file '{}' at line {}", location.file(), location.line()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By convention, Rust uses four spaces for indentation, you'll need to do something like this instead:
/// println!("panic occurred in file '{}' at line {}",
/// location.file(), location.line());
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah , ok. Thank you.
Thanks! @bors r=Mark-Simulacrum |
📌 Commit 7ec4d14 has been approved by |
Fixing basic typos in Doc Comments Files checked : *.rs files inside 'src' directory. Only Doc comments (/// and //!) are fixed. Note: the non American-English spellings are left unchanged.
@bors r- |
We specifically do use |
Traivis is failing due to
After travis passes and the commits are squashed, r=me! |
☔ The latest upstream changes (presumably #42924) made this pull request unmergeable. Please resolve the merge conflicts. |
Hi @Fourchaux, have you had a chance to look at the trailing whitespace issue raised by the tidy check? |
Oh and it'd be great if you could squash your commits into one while you're at it! |
Hi @Fourchaux, as this has been inactive for a while I'm going to it to keep the PR queue tidy - if you do get round to updating, feel free to reopen. Thanks again for the changes! |
Fix typos & us spellings Fixing some typos and non en-US spellings. (Update of PR rust-lang#42812 )
Fix typos & us spellings Fixing some typos and non en-US spellings. (Update of PR rust-lang/rust#42812 )
Files checked : *.rs files inside 'src' directory.
Only Doc comments (/// and //!) are fixed.
Note: the non American-English spellings are left unchanged.