From db19bf06244d969361b60e780566acdae13b696e Mon Sep 17 00:00:00 2001
From: Valentin Brandl <vbrandl@riseup.net>
Date: Sat, 15 Jul 2017 15:35:03 +0200
Subject: [PATCH] Document default values for primitive types

---
 src/libcore/default.rs | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

diff --git a/src/libcore/default.rs b/src/libcore/default.rs
index 0d7c1672fbcd..45ab4f38b05e 100644
--- a/src/libcore/default.rs
+++ b/src/libcore/default.rs
@@ -126,32 +126,33 @@ pub trait Default: Sized {
 }
 
 macro_rules! default_impl {
-    ($t:ty, $v:expr) => {
+    ($t:ty, $v:expr, $doc:expr) => {
         #[stable(feature = "rust1", since = "1.0.0")]
         impl Default for $t {
             #[inline]
+            #[doc = $doc]
             fn default() -> $t { $v }
         }
     }
 }
 
-default_impl! { (), () }
-default_impl! { bool, false }
-default_impl! { char, '\x00' }
+default_impl! { (), (), "Defaults to `()`" }
+default_impl! { bool, false, "Defaults to `false`" }
+default_impl! { char, '\x00', "Defaults to `\\x00`" }
 
-default_impl! { usize, 0 }
-default_impl! { u8, 0 }
-default_impl! { u16, 0 }
-default_impl! { u32, 0 }
-default_impl! { u64, 0 }
-default_impl! { u128, 0 }
+default_impl! { usize, 0, "Defaults to `0`" }
+default_impl! { u8, 0, "Defaults to `0`" }
+default_impl! { u16, 0, "Defaults to `0`" }
+default_impl! { u32, 0, "Defaults to `0`" }
+default_impl! { u64, 0, "Defaults to `0`" }
+default_impl! { u128, 0, "Defaults to `0`" }
 
-default_impl! { isize, 0 }
-default_impl! { i8, 0 }
-default_impl! { i16, 0 }
-default_impl! { i32, 0 }
-default_impl! { i64, 0 }
-default_impl! { i128, 0 }
+default_impl! { isize, 0, "Defaults to `0`" }
+default_impl! { i8, 0, "Defaults to `0`" }
+default_impl! { i16, 0, "Defaults to `0`" }
+default_impl! { i32, 0, "Defaults to `0`" }
+default_impl! { i64, 0, "Defaults to `0`" }
+default_impl! { i128, 0, "Defaults to `0`" }
 
-default_impl! { f32, 0.0f32 }
-default_impl! { f64, 0.0f64 }
+default_impl! { f32, 0.0f32, "Defaults to `0.0`" }
+default_impl! { f64, 0.0f64, "Defaults to `0.0`" }