about summary refs log tree commit diff
path: root/src/libstd/thread
diff options
context:
space:
mode:
authorFelix Raimundo <felix.raimundo@tweag.io>2017-05-09 13:27:22 +0200
committerFelix Raimundo <felix.raimundo@tweag.io>2017-05-09 13:27:22 +0200
commit9db31206f597444258a46220f39fde13a76453e2 (patch)
treee2c2351b8a3e98ae4d90f80c909debec629490f7 /src/libstd/thread
parentc655348f26a179193f5d6d1a3a2fbe000a046699 (diff)
downloadrust-9db31206f597444258a46220f39fde13a76453e2.tar.gz
rust-9db31206f597444258a46220f39fde13a76453e2.zip
Add a link to `thread::Builder` in `thread::spawn`
Diffstat (limited to 'src/libstd/thread')
-rw-r--r--src/libstd/thread/mod.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index c1e894510b9..19adf3e3c3f 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -389,6 +389,10 @@ impl Builder {
 /// panics, [`join`] will return an [`Err`] containing the argument given to
 /// [`panic`].
 ///
+/// This will create a thread using default parameters of [`Builder`], if you
+/// want to specify the stack size or the name of the thread, use this API
+/// instead.
+///
 /// # Panics
 ///
 /// Panics if the OS fails to create a thread; use [`Builder::spawn`]
@@ -454,6 +458,7 @@ impl Builder {
 /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
 /// [`panic`]: ../../std/macro.panic.html
 /// [`Builder::spawn`]: ../../std/thread/struct.Builder.html#method.spawn
+/// [`Builder`]: ../../std/thread/struct.Builder.html
 #[stable(feature = "rust1", since = "1.0.0")]
 pub fn spawn<F, T>(f: F) -> JoinHandle<T> where
     F: FnOnce() -> T, F: Send + 'static, T: Send + 'static