Updated the docs for Error::description

This commit is contained in:
Nabeel Omer 2016-10-15 19:13:49 +05:30
parent 030bc49bb4
commit a1b50ad673

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