about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSimonas Kazlauskas <git@kazlauskas.me>2015-01-17 23:44:04 +0200
committerSimonas Kazlauskas <git@kazlauskas.me>2015-01-17 23:53:53 +0200
commit618cf5f8d79dc92bcbdbe2c0e91d681e2e685cd7 (patch)
treebfec10daaa0ee31312843bf37638f39c4b11e448
parent89c4e3792ddc5b45706ea0e919806a248f7a87c3 (diff)
downloadrust-618cf5f8d79dc92bcbdbe2c0e91d681e2e685cd7.tar.gz
rust-618cf5f8d79dc92bcbdbe2c0e91d681e2e685cd7.zip
Refine wording of Thread::panicking
Previous wording wasn’t clear about its actual behaviour. It could be
interpreted as answering either:

* Can current thread panic?
* Is current thread unwinding because of panic?
-rw-r--r--src/libstd/rt/unwind.rs2
-rw-r--r--src/libstd/thread.rs2
2 files changed, 2 insertions, 2 deletions
diff --git a/src/libstd/rt/unwind.rs b/src/libstd/rt/unwind.rs
index 73b8f104c23..b313a5312bc 100644
--- a/src/libstd/rt/unwind.rs
+++ b/src/libstd/rt/unwind.rs
@@ -152,7 +152,7 @@ pub unsafe fn try<F: FnOnce()>(f: F) -> Result<(), Box<Any + Send>> {
     }
 }
 
-/// Test if the current thread is currently panicking.
+/// Determines whether the current thread is unwinding because of panic.
 pub fn panicking() -> bool {
     PANICKING.with(|s| s.get())
 }
diff --git a/src/libstd/thread.rs b/src/libstd/thread.rs
index 932556fe1a6..bcd4dee63b0 100644
--- a/src/libstd/thread.rs
+++ b/src/libstd/thread.rs
@@ -382,7 +382,7 @@ impl Thread {
         unsafe { imp::yield_now() }
     }
 
-    /// Determines whether the current thread is panicking.
+    /// Determines whether the current thread is unwinding because of panic.
     #[inline]
     #[stable]
     pub fn panicking() -> bool {