Skip to content

Commit 28416cb

Browse files
Rollup merge of rust-lang#37189 - nabeelomer:master, r=bluss
Updated the docs for Error::description Fixes rust-lang#37163
2 parents 1aac569 + 16b8957 commit 28416cb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/libstd/error.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,11 @@ use string;
6565
pub trait Error: Debug + Display {
6666
/// A short description of the error.
6767
///
68-
/// The description should not contain newlines or sentence-ending
69-
/// punctuation, to facilitate embedding in larger user-facing
70-
/// strings.
68+
/// The description should only be used for a simple message.
69+
/// It should not contain newlines or sentence-ending punctuation,
70+
/// to facilitate embedding in larger user-facing strings.
71+
/// For showing formatted error messages with more information see
72+
/// [Display](https://doc.rust-lang.org/std/fmt/trait.Display.html).
7173
///
7274
/// # Examples
7375
///

0 commit comments

Comments
 (0)