Rollup merge of #37189 - nabeelomer:master, r=bluss

Updated the docs for Error::description

Fixes https://github.com/rust-lang/rust/issues/37163
This commit is contained in:
Guillaume Gomez 2016-10-17 23:07:52 +02:00 committed by GitHub
commit 28416cbbff

View File

@ -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
///