Updated the docs for Error::description

rust-lang · Oct 15, 2016 · a1b50ad · a1b50ad
1 parent 030bc49
commit a1b50ad
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/libstd/error.rs b/src/libstd/error.rs
@@ -65,9 +65,11 @@ use string;
 pub trait Error: Debug + Display {
     /// A short description of the error.
     ///
-    /// The description should not contain newlines or sentence-ending
-    /// punctuation, to facilitate embedding in larger user-facing
-    /// strings.
+    /// The description should only be used for a simple message.
+    /// It should not contain newlines or sentence-ending punctuation,
+    /// to facilitate embedding in larger user-facing strings.
+    /// For showing formatted error messages with more information see
+    /// (Display)[https://doc.rust-lang.org/std/fmt/trait.Display.html].
     ///
     /// # Examples
     ///