From ad0667f9724edcd693764e608aa5f49683f080af Mon Sep 17 00:00:00 2001
From: Mara Bos <m-ou.se@m-ou.se>
Date: Thu, 16 May 2024 11:54:11 +0200
Subject: [PATCH] Add note on panic payload type.

---
 std/src/panic.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/std/src/panic.rs b/std/src/panic.rs
index 51228cc990751..d5566caa369cf 100644
--- a/std/src/panic.rs
+++ b/std/src/panic.rs
@@ -63,6 +63,13 @@ impl<'a> PanicHookInfo<'a> {
     ///
     /// This will commonly, but not always, be a `&'static str` or [`String`].
     ///
+    /// A invocation of the `panic!()` macro in Rust 2021 or later will always result in a
+    /// panic payload of type `&'static str` or `String`.
+    ///
+    /// Only an invocation of [`panic_any`]
+    /// (or, in Rust 2018 and earlier, `panic!(x)` where `x` is something other than a string)
+    /// can result in a panic payload other than a `&'static str` or `String`.
+    ///
     /// [`String`]: ../../std/string/struct.String.html
     ///
     /// # Examples