about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorTobias Bucher <tobiasbucher5991@gmail.com>2015-07-23 15:43:06 +0200
committerTobias Bucher <tobiasbucher5991@gmail.com>2015-07-23 15:44:06 +0200
commita700546feabd85fa06f2bbd446865c15431c0e09 (patch)
tree7f25b0d5686c56927ebc71f837e475f32fcc0401 /src/libstd
parentd4d4206e5604b86fc4a9b28a8b51d99121cc3a5d (diff)
downloadrust-a700546feabd85fa06f2bbd446865c15431c0e09.tar.gz
rust-a700546feabd85fa06f2bbd446865c15431c0e09.zip
Fix `thread::catch_panic` documentation to mention its return value on success
Fixes #27027.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/thread/mod.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index 3299c848ba7..20fcd309a6b 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -434,9 +434,9 @@ pub fn panicking() -> bool {
 
 /// Invokes a closure, capturing the cause of panic if one occurs.
 ///
-/// This function will return `Ok(())` if the closure does not panic, and will
-/// return `Err(cause)` if the closure panics. The `cause` returned is the
-/// object with which panic was originally invoked.
+/// This function will return `Ok` with the closure's result if the closure
+/// does not panic, and will return `Err(cause)` if the closure panics. The
+/// `cause` returned is the object with which panic was originally invoked.
 ///
 /// It is currently undefined behavior to unwind from Rust code into foreign
 /// code, so this function is particularly useful when Rust is called from