Add stack size doc to thread::spawn.

Part of #29378
This commit is contained in:
Felix Raimundo
2017-05-07 18:42:36 +02:00
parent ced823e267
commit ddb9e50b45

View File

@@ -244,6 +244,11 @@ impl Builder {
/// Generates the base configuration for spawning a thread, from which
/// configuration methods can be chained.
///
/// If the [`stack_size`][stack_size] field is not specified, the stack size
/// will be the `RUST_MIN_STACK` environment variable, if it is
/// not specified either, a sensible default size will be set (2MB as
/// of the writting of this doc).
///
/// # Examples
///
/// ```
@@ -259,6 +264,8 @@ impl Builder {
///
/// handler.join().unwrap();
/// ```
///
/// [stack_size]: ../../std/thread/struct.Builder.html#method.stack_size
#[stable(feature = "rust1", since = "1.0.0")]
pub fn new() -> Builder {
Builder {