Skip to content

Commit

Permalink
Rollup merge of rust-lang#72551 - alilleybrinker:document-debug-stabi…
Browse files Browse the repository at this point in the history
…lity, 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 rust-lang#62794.
  • Loading branch information
RalfJung authored May 25, 2020
2 parents 4f4b716 + 698df11 commit 7c9fdb3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/libcore/fmt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,13 @@ impl Display for Arguments<'_> {
/// `enum`s, it will use the name of the variant and, if applicable, `(`, then the
/// `Debug` values of the fields, then `)`.
///
/// # Stability
///
/// Derived `Debug` formats are not stable, and so may change with future Rust
/// versions. Additionally, `Debug` implementations of types provided by the
/// standard library (`libstd`, `libcore`, `liballoc`, etc.) are not stable, and
/// may also change with future Rust versions.
///
/// # Examples
///
/// Deriving an implementation:
Expand Down

0 comments on commit 7c9fdb3

Please sign in to comment.