Skip to content
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

Closed
wants to merge 29 commits into from
Closed

Conversation

Fourchaux
Copy link
Contributor

Files checked : *.rs files inside 'src' directory.

Only Doc comments (/// and //!) are fixed.

Note: the non American-English spellings are left unchanged.

@rust-highfive
Copy link
Collaborator

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.

@Mark-Simulacrum
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 21, 2017

📌 Commit a21e056 has been approved by Mark-Simulacrum

@@ -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());
Copy link
Member

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

Copy link
Member

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

@frewsxcv
Copy link
Member

@bors r-

@@ -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());
Copy link
Member

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());

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah , ok. Thank you.

@frewsxcv
Copy link
Member

Thanks!

@bors r=Mark-Simulacrum

@bors
Copy link
Contributor

bors commented Jun 22, 2017

📌 Commit 7ec4d14 has been approved by Mark-Simulacrum

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Jun 22, 2017
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.
@frewsxcv
Copy link
Member

@bors r-

@frewsxcv frewsxcv added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jun 22, 2017
@steveklabnik
Copy link
Member

Note: the non American-English spellings are left unchanged.

We specifically do use en-US for the standard library docs, so changing these would also be welcome!

@steveklabnik
Copy link
Member

Traivis is failing due to

[00:02:11] tidy error: /checkout/src/libstd/panicking.rs:224: trailing whitespace

After travis passes and the commits are squashed, r=me!

@bors
Copy link
Contributor

bors commented Jun 30, 2017

☔ The latest upstream changes (presumably #42924) made this pull request unmergeable. Please resolve the merge conflicts.

@aidanhs
Copy link
Member

aidanhs commented Jul 5, 2017

Hi @Fourchaux, have you had a chance to look at the trailing whitespace issue raised by the tidy check?

@aidanhs
Copy link
Member

aidanhs commented Jul 5, 2017

Oh and it'd be great if you could squash your commits into one while you're at it!

@aidanhs
Copy link
Member

aidanhs commented Jul 13, 2017

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!

@aidanhs aidanhs closed this Jul 13, 2017
@aidanhs aidanhs added S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 13, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Aug 17, 2017
Fix typos & us spellings

Fixing some typos and non en-US spellings.

(Update of PR rust-lang#42812 )
spikespaz pushed a commit to spikespaz/dotwalk-rs that referenced this pull request Aug 29, 2024
Fix typos & us spellings

Fixing some typos and non en-US spellings.

(Update of PR rust-lang/rust#42812 )
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants