Skip to content

Commit 7c9fdb3

Browse files
authored
Rollup merge of #72551 - alilleybrinker:document-debug-stability, r=KodrAus
First draft documenting Debug stability. Debug implementations of std types aren't stable, and neither are derived Debug implementations for any types, including user-defined types. This commit adds a section to the Debug documentation noting this stability status. This issue is tracked by #62794.
2 parents 4f4b716 + 698df11 commit 7c9fdb3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/libcore/fmt/mod.rs

+7
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,13 @@ impl Display for Arguments<'_> {
441441
/// `enum`s, it will use the name of the variant and, if applicable, `(`, then the
442442
/// `Debug` values of the fields, then `)`.
443443
///
444+
/// # Stability
445+
///
446+
/// Derived `Debug` formats are not stable, and so may change with future Rust
447+
/// versions. Additionally, `Debug` implementations of types provided by the
448+
/// standard library (`libstd`, `libcore`, `liballoc`, etc.) are not stable, and
449+
/// may also change with future Rust versions.
450+
///
444451
/// # Examples
445452
///
446453
/// Deriving an implementation:

0 commit comments

Comments
 (0)