chore(lib): Enhance documentation for core::fmt::Formatter's write_fm…

…t method
carolynzech · Aug 12, 2024 · 7dd2083 · 7dd2083
1 parent 9147777
commit 7dd2083
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/src/fmt/mod.rs b/core/src/fmt/mod.rs
@@ -1626,6 +1626,11 @@ impl<'a> Formatter<'a> {
         self.buf.write_str(data)
     }
 
+    /// Glue for usage of the [`write!`] macro with implementors of this trait.
+    ///
+    /// This method should generally not be invoked manually, but rather through
+    /// the [`write!`] macro itself.
+    /// 
     /// Writes some formatted information into this instance.
     ///
     /// # Examples