diff options
| author | Nabeel Omer <nabeelkomer@gmail.com> | 2016-10-15 19:13:49 +0530 |
|---|---|---|
| committer | Nabeel Omer <nabeelkomer@gmail.com> | 2016-10-15 19:13:49 +0530 |
| commit | a1b50ad6730f0f393847d14625811a75b4be36bf (patch) | |
| tree | a7876eaa1b46110e35a1ae6ca09ee94782d97109 | |
| parent | 030bc49bb44834e691fd67452b39b438fa6d826d (diff) | |
| download | rust-a1b50ad6730f0f393847d14625811a75b4be36bf.tar.gz rust-a1b50ad6730f0f393847d14625811a75b4be36bf.zip | |
Updated the docs for Error::description
| -rw-r--r-- | src/libstd/error.rs | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/libstd/error.rs b/src/libstd/error.rs index 398bb55ea1b..5702d6aefdf 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 /// |