about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2017-05-04 21:35:28 -0400
committerGitHub <noreply@github.com>2017-05-04 21:35:28 -0400
commit63e477d51d59c257e3b71aca2350867bf8b78e59 (patch)
treec5e18c781aed136e69c25ec015406156569e0b21 /src/libstd
parent59f1a2f948a5e17d6675957813376ad8cc1d95ec (diff)
parent93e179a8c132f6aa9790b198cdcdd441424b4a84 (diff)
downloadrust-63e477d51d59c257e3b71aca2350867bf8b78e59.tar.gz
rust-63e477d51d59c257e3b71aca2350867bf8b78e59.zip
Rollup merge of #41741 - rap2hpoutre:patch-3, r=steveklabnik
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 https://github.com/rust-lang/rust/issues/29378 (about Result). It's still one of my first PR. Sorry if I missed something.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/thread/mod.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index 4e49c485f10..8e7eaa77cd7 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -66,7 +66,7 @@
 //! let res = child.join();
 //! ```
 //!
-//! The [`join`] method returns a [`Result`] containing [`Ok`] of the final
+//! The [`join`] method returns a [`thread::Result`] containing [`Ok`] of the final
 //! value produced by the child thread, or [`Err`] of the value given to
 //! a call to [`panic!`] if the child panicked.
 //!
@@ -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/type.Result.html
 //! [`Thread`]: ../../std/thread/struct.Thread.html
 //! [`park`]: ../../std/thread/fn.park.html
 //! [`unpark`]: ../../std/thread/struct.Thread.html#method.unpark