Updated the docs for Error::description
This commit is contained in:
@@ -65,9 +65,11 @@ use string;
|
|||||||
pub trait Error: Debug + Display {
|
pub trait Error: Debug + Display {
|
||||||
/// A short description of the error.
|
/// A short description of the error.
|
||||||
///
|
///
|
||||||
/// The description should not contain newlines or sentence-ending
|
/// The description should only be used for a simple message.
|
||||||
/// punctuation, to facilitate embedding in larger user-facing
|
/// It should not contain newlines or sentence-ending punctuation,
|
||||||
/// strings.
|
/// 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
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
|||||||
Reference in New Issue
Block a user