diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2016-10-17 23:07:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-17 23:07:52 +0200 |
| commit | 28416cbbffc6d655e5880cf26673257e47a5432a (patch) | |
| tree | 6c034da90c27acb482f1cf7ae1b939d3b32b6267 /src/libstd | |
| parent | 1aac569e8a363b87fa34580d3082d35e515aff8f (diff) | |
| parent | 16b8957df425bbde4a3739a025a1573b13f6bd6b (diff) | |
| download | rust-28416cbbffc6d655e5880cf26673257e47a5432a.tar.gz rust-28416cbbffc6d655e5880cf26673257e47a5432a.zip | |
Rollup merge of #37189 - nabeelomer:master, r=bluss
Updated the docs for Error::description Fixes https://github.com/rust-lang/rust/issues/37163
Diffstat (limited to 'src/libstd')
| -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..a1909b0f957 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 /// |