about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--library/core/src/fmt/mod.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/library/core/src/fmt/mod.rs b/library/core/src/fmt/mod.rs
index 2d4f477ca01..8a2a64f8dc9 100644
--- a/library/core/src/fmt/mod.rs
+++ b/library/core/src/fmt/mod.rs
@@ -572,16 +572,20 @@ impl Display for Arguments<'_> {
 ///
 /// [`debug_struct`]: Formatter::debug_struct
 ///
-/// For custom cases, it's also possible to implement `Debug` using the [`write!`] macro:
+/// Types that do not wish to use the standard suite of debug representations
+/// provided by the `Formatter` trait (`debug_struct`, `debug_tuple`,
+/// `debut_list`, `debug_set`, `debug_map`) can do something totally custom by
+/// manually writing an arbitrary representation to the `Formatter`.
+///
 /// ```
 /// # use std::fmt;
 /// # struct Point {
 /// #     x: i32,
 /// #     y: i32,
 /// # }
-///
+/// #
 /// impl fmt::Debug for Point {
-///     fn fmt(&self, f: &mut fmt::Formatter <'_>) -> fmt::Result {
+///     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 ///         write!(f, "Point [{} {}]", self.x, self.y)
 ///     }
 /// }