about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJulian Frimmel <julian.frimmel@gmail.com>2021-03-18 09:52:21 +0100
committerJulian Frimmel <julian.frimmel@gmail.com>2021-03-18 09:52:21 +0100
commit55d9e0f601d9154d99a2fec3d803b42cbf60ff2a (patch)
tree38a8da82aca9719f65987b30fa336153f5211714
parentb4adc21c4fa245994b4936df5b4f7d94ca633c5d (diff)
downloadrust-55d9e0f601d9154d99a2fec3d803b42cbf60ff2a.tar.gz
rust-55d9e0f601d9154d99a2fec3d803b42cbf60ff2a.zip
Include output stream in `panic!()` documentation
-rw-r--r--library/core/src/macros/panic.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/library/core/src/macros/panic.md b/library/core/src/macros/panic.md
index 6e502426df9..e5e286ca5a2 100644
--- a/library/core/src/macros/panic.md
+++ b/library/core/src/macros/panic.md
@@ -10,8 +10,8 @@ tests. `panic!` is closely tied with the `unwrap` method of both
 `panic!` when they are set to [`None`] or [`Err`] variants.
 
 This macro is used to inject panic into a Rust thread, causing the thread to
-panic entirely. This macro panics with a string and uses the [`format!`] syntax
-for building the message.
+panic entirely. The string built by this macro (using the [`format!`] syntax
+for building the actual message) is printed to `stderr`.
 
 Each thread's panic can be reaped as the [`Box`]`<`[`Any`]`>` type,
 which contains either a `&str` or `String` for regular `panic!()` invocations.