about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMarkMcCaskey <rabidwaffle@gmail.com>2017-08-30 22:26:54 -0400
committerMarkMcCaskey <rabidwaffle@gmail.com>2017-08-30 22:26:54 -0400
commit1d69c985be6a196e4a30f6deb0d8347aaad62662 (patch)
tree93f7f7f400fb3f05deb39bc783aa51bc68e0d2cf
parent51a54b6dc0b51d270d46d9d388e627201f0986db (diff)
downloadrust-1d69c985be6a196e4a30f6deb0d8347aaad62662.tar.gz
rust-1d69c985be6a196e4a30f6deb0d8347aaad62662.zip
update unimplemented! docs
-rw-r--r--src/libcore/macros.rs7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libcore/macros.rs b/src/libcore/macros.rs
index 684b81a27f8..375c1f10db2 100644
--- a/src/libcore/macros.rs
+++ b/src/libcore/macros.rs
@@ -516,13 +516,16 @@ macro_rules! unreachable {
     });
 }
 
-/// A standardized placeholder for marking unfinished code. It panics with the
-/// message `"not yet implemented"` when executed.
+/// A standardized placeholder for marking unfinished code.
 ///
 /// This can be useful if you are prototyping and are just looking to have your
 /// code typecheck, or if you're implementing a trait that requires multiple
 /// methods, and you're only planning on using one of them.
 ///
+/// # Panics
+///
+/// This will always [panic!](macro.panic.html)
+///
 /// # Examples
 ///
 /// Here's an example of some in-progress code. We have a trait `Foo`: