From 1d69c985be6a196e4a30f6deb0d8347aaad62662 Mon Sep 17 00:00:00 2001 From: MarkMcCaskey Date: Wed, 30 Aug 2017 22:26:54 -0400 Subject: [PATCH] update unimplemented! docs --- src/libcore/macros.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/libcore/macros.rs b/src/libcore/macros.rs index 684b81a27f82e..375c1f10db2c3 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`: