about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2016-10-17 17:35:16 -0700
committerGitHub <noreply@github.com>2016-10-17 17:35:16 -0700
commit1d3dfa5301f59e86547a4034fb654c4efb47ac0e (patch)
tree263b02a1cec4bb38e915bf02672ac3496536c201 /src/libstd
parente0111758eb4f215db4ec26f809ef3edf5dfb66f5 (diff)
parentb097790182dd0868812897d3fd1be2e6a5083a16 (diff)
downloadrust-1d3dfa5301f59e86547a4034fb654c4efb47ac0e.tar.gz
rust-1d3dfa5301f59e86547a4034fb654c4efb47ac0e.zip
Auto merge of #37237 - GuillaumeGomez:rollup, r=GuillaumeGomez
Rollup of 6 pull requests

- Successful merges: #37172, #37177, #37189, #37194, #37200, #37215
- Failed merges:
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/error.rs8
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
     ///