From a1b50ad6730f0f393847d14625811a75b4be36bf Mon Sep 17 00:00:00 2001 From: Nabeel Omer Date: Sat, 15 Oct 2016 19:13:49 +0530 Subject: [PATCH 1/3] Updated the docs for Error::description --- src/libstd/error.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/libstd/error.rs b/src/libstd/error.rs index 398bb55ea1bf6..5702d6aefdffe 100644 --- 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 /// From 57583722f6aac832ee358a58a29f4da77f3ce597 Mon Sep 17 00:00:00 2001 From: Nabeel Omer Date: Sat, 15 Oct 2016 21:30:09 +0530 Subject: [PATCH 2/3] Corrected broken markdown link --- src/libstd/error.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libstd/error.rs b/src/libstd/error.rs index 5702d6aefdffe..8b953a1ea5285 100644 --- a/src/libstd/error.rs +++ b/src/libstd/error.rs @@ -69,7 +69,7 @@ pub trait Error: Debug + Display { /// 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]. + /// [Display](https://doc.rust-lang.org/std/fmt/trait.Display.html).s /// /// # Examples /// From 16b8957df425bbde4a3739a025a1573b13f6bd6b Mon Sep 17 00:00:00 2001 From: Nabeel Omer Date: Sat, 15 Oct 2016 22:56:07 +0530 Subject: [PATCH 3/3] Fixed typo --- src/libstd/error.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libstd/error.rs b/src/libstd/error.rs index 8b953a1ea5285..a1909b0f95789 100644 --- a/src/libstd/error.rs +++ b/src/libstd/error.rs @@ -69,7 +69,7 @@ pub trait Error: Debug + Display { /// 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).s + /// [Display](https://doc.rust-lang.org/std/fmt/trait.Display.html). /// /// # Examples ///