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

join method returns a thread::Result #41741

Merged
merged 3 commits into from
May 5, 2017
Merged

Conversation

rap2hpoutre
Copy link
Contributor

Join method returns a std::thread::Result, not a std::result::Result: https://doc.rust-lang.org/std/thread/struct.JoinHandle.html#method.join Maybe I misunderstood something.

I have seen this mistake(?) because I wanted to tackle this issue #29378 (about Result). It's still one of my first PR. Sorry if I missed something.

@rust-highfive
Copy link
Collaborator

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

@rap2hpoutre
Copy link
Contributor Author

r? @steveklabnik (I think it's you, cause you created the issue)

@rust-highfive rust-highfive assigned steveklabnik and unassigned brson May 4, 2017
@rap2hpoutre rap2hpoutre changed the title Join method returns a thread::Result join method returns a thread::Result May 4, 2017
@steveklabnik
Copy link
Member

You're not wrong! While thread::Result is a Result, it's better to be more specific.

There's one problem with this PR, though, I think: you haven't created the actual link yet! That is, this won't inherently generate a link; check out all the stuff at the bottom of the comment block. Let me know if that doesn't make sense and I can help out!

@rap2hpoutre
Copy link
Contributor Author

Thank you! I'm sorry I did not noticed that.

I tried to fix this by myself (last commit). Though I'm still not sure I did it well. Is there a documentation for this (how to link in doc)?

@@ -159,6 +159,7 @@
//! [`panic!`]: ../../std/macro.panic.html
//! [`Builder`]: ../../std/thread/struct.Builder.html
//! [`thread::current`]: ../../std/thread/fn.current.html
//! [`thread::Result`]: ../../std/thread/struct.Result.html
Copy link
Member

Choose a reason for hiding this comment

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

this should be ../../std/thread/type.Result.html

type not struct :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops :/

@steveklabnik
Copy link
Member

I tried to fix this by myself (last commit). Though I'm still not sure I did it well. Is there a documentation for this (how to link in doc)?

It's Markdown syntax, so we don't have specific docs for it, since any markdown reference covers it. That said, you got it perfect, except one tiny little thing. If we change that it's good to go!

@rap2hpoutre
Copy link
Contributor Author

Oops. Done! Thanks again for mentoring!!

@steveklabnik
Copy link
Member

@bors: r+ rollup

Thank you for the contribution! 🎊

@bors
Copy link
Contributor

bors commented May 4, 2017

📌 Commit 93e179a has been approved by steveklabnik

@alexcrichton alexcrichton added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label May 4, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 5, 2017
join method returns a thread::Result

Join method returns a std::thread::Result, not a std::result::Result: https://doc.rust-lang.org/std/thread/struct.JoinHandle.html#method.join Maybe I misunderstood something.

I have seen this mistake(?) because I wanted to tackle this issue rust-lang#29378 (about Result). It's still one of my first PR. Sorry if I missed something.
frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 5, 2017
join method returns a thread::Result

Join method returns a std::thread::Result, not a std::result::Result: https://doc.rust-lang.org/std/thread/struct.JoinHandle.html#method.join Maybe I misunderstood something.

I have seen this mistake(?) because I wanted to tackle this issue rust-lang#29378 (about Result). It's still one of my first PR. Sorry if I missed something.
bors added a commit that referenced this pull request May 5, 2017
Rollup of 4 pull requests

- Successful merges: #41741, #41746, #41749, #41754
- Failed merges:
@bors bors merged commit 93e179a into rust-lang:master May 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants