about summary refs log tree commit diff
path: root/library/core/src/panic
diff options
context:
space:
mode:
authorMara Bos <m-ou.se@m-ou.se>2024-06-12 13:17:42 +0200
committerMara Bos <m-ou.se@m-ou.se>2024-06-12 13:17:42 +0200
commit9afc91349e508121a2cc1d15402736b09a2527b6 (patch)
tree28b8ff1e6f06c05053be5cb8ccddb0046c8c5755 /library/core/src/panic
parent2944eab5e67b732f994df4fdefaa43e9ef225682 (diff)
downloadrust-9afc91349e508121a2cc1d15402736b09a2527b6.tar.gz
rust-9afc91349e508121a2cc1d15402736b09a2527b6.zip
Update doc comment on PanicInfo::message().
Diffstat (limited to 'library/core/src/panic')
-rw-r--r--library/core/src/panic/panic_info.rs5
1 files changed, 2 insertions, 3 deletions
diff --git a/library/core/src/panic/panic_info.rs b/library/core/src/panic/panic_info.rs
index 1925f8e8eac..c8e507c690e 100644
--- a/library/core/src/panic/panic_info.rs
+++ b/library/core/src/panic/panic_info.rs
@@ -29,9 +29,8 @@ impl<'a> PanicInfo<'a> {
         PanicInfo { location, message, can_unwind, force_no_backtrace }
     }
 
-    /// If the `panic!` macro from the `core` crate (not from `std`)
-    /// was used with a formatting string and some additional arguments,
-    /// returns that message ready to be used for example with [`fmt::write`]
+    /// The message that was given to the `panic!` macro,
+    /// ready to be formatted with e.g. [`fmt::write`].
     #[must_use]
     #[unstable(feature = "panic_info_message", issue = "66745")]
     pub fn message(&self) -> fmt::Arguments<'_> {