diff options
| author | Andrew Lilley Brinker <andrewabrinker@gmail.com> | 2020-05-24 15:30:48 -0700 |
|---|---|---|
| committer | Andrew Lilley Brinker <andrewabrinker@gmail.com> | 2020-05-24 15:30:48 -0700 |
| commit | 698df11af56f1326bb6509e8c1329b463b0afc9c (patch) | |
| tree | 75d99c825ea45d1db3a4ed8d08da442caff90b26 | |
| parent | ff991d60349201a90ca15202dd0323ebdfab8745 (diff) | |
| download | rust-698df11af56f1326bb6509e8c1329b463b0afc9c.tar.gz rust-698df11af56f1326bb6509e8c1329b463b0afc9c.zip | |
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 documentatio noting this stability status.
| -rw-r--r-- | src/libcore/fmt/mod.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/libcore/fmt/mod.rs b/src/libcore/fmt/mod.rs index 95411b525d0..3d90fe1fa2f 100644 --- a/src/libcore/fmt/mod.rs +++ b/src/libcore/fmt/mod.rs @@ -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: |