diff options
| author | Ralf Jung <post@ralfj.de> | 2020-05-25 11:01:10 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-25 11:01:10 +0200 |
| commit | 7c9fdb332bdca945f15627bd4e16f16dc5972b2c (patch) | |
| tree | 932ee2699b0054784a1546b9060d3808ddc9b231 /src | |
| parent | 4f4b716675cfea6b24d3fc5b47e165875bb76506 (diff) | |
| parent | 698df11af56f1326bb6509e8c1329b463b0afc9c (diff) | |
| download | rust-7c9fdb332bdca945f15627bd4e16f16dc5972b2c.tar.gz rust-7c9fdb332bdca945f15627bd4e16f16dc5972b2c.zip | |
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.
Diffstat (limited to 'src')
| -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: |