Addressed review comments.

This commit is contained in:
Pyry Kontio 2019-11-06 14:47:52 +09:00 committed by Pyry Kontio
parent 002c1c74d9
commit f1bc4ef170

View file

@ -1273,15 +1273,15 @@ impl fmt::Debug for Thread {
///
/// The value contained in the `Result::Err` variant
/// is the value the thread panicked with;
/// that is, the parameter the `panic!` macro was called with.
/// that is, the argument the `panic!` macro was called with.
/// Unlike with normal errors, this value doesn't implement
/// the `std::error::Error` trait.
/// the [`Error`] trait.
///
/// Thus, a sensible way to handle a thread panic is to either
/// `unwrap` the `Result`, propagating the panic,
/// or in case the thread is intended to be a subsystem boundary
/// Thus, a sensible way to handle a thread panic is to either:
/// 1. `unwrap` the `Result<T>`, propagating the panic
/// 2. or in case the thread is intended to be a subsystem boundary
/// that is supposed to isolate system-level failures,
/// match for the `Err` variant and handle the panic in an appropriate way.
/// match on the `Err` variant and handle the panic in an appropriate way.
///
/// A thread that completes without panicking is considered to exit successfully.
///