bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

First draft documenting Debug stability.

Browse source 
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 documentatio noting this
stability status.
This commit is contained in:
Andrew Lilley Brinker 2020-05-24 15:30:48 -07:00
parent ff991d6034
commit 698df11af5
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/libcore/fmt/mod.rs
View file

@ -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: