summary refs log tree commit diff
path: root/library/alloc/src
diff options
context:
space:
mode:
authorElias Holzmann <9659253+EliasHolzmann@users.noreply.github.com>2022-04-30 02:40:39 +0200
committerElias Holzmann <9659253+EliasHolzmann@users.noreply.github.com>2022-05-01 15:27:41 +0200
commitc70f3ab5e53916a2e0210a24b67c64f2b700a06f (patch)
tree095518446a018b078cc27b811cf9439a29100152 /library/alloc/src
parent79d9afda137cfeb30cefdce397851b8e20db4ae1 (diff)
downloadrust-c70f3ab5e53916a2e0210a24b67c64f2b700a06f.tar.gz
rust-c70f3ab5e53916a2e0210a24b67c64f2b700a06f.zip
std::fmt: Removed reference to Formatter::buf and other private fields
Formatter::buf is not a public field and therefore isn't very helpful in user-
facing documentation. Also, the other public fields of Formatter were made
private during stabilization of std::fmt (4af3494bb0) and can now only be read
via accessor methods.
Diffstat (limited to 'library/alloc/src')
-rw-r--r--library/alloc/src/fmt.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/library/alloc/src/fmt.rs b/library/alloc/src/fmt.rs
index 7b12f6e86c1..635a3ffa3c5 100644
--- a/library/alloc/src/fmt.rs
+++ b/library/alloc/src/fmt.rs
@@ -369,9 +369,9 @@
 //! ```
 //!
 //! Your type will be passed as `self` by-reference, and then the function
-//! should emit output into the `f.buf` stream. It is up to each format trait
-//! implementation to correctly adhere to the requested formatting parameters.
-//! The values of these parameters will be listed in the fields of the
+//! should emit output into the Formatter `f` which implements `fmt::Write`. It is up to each
+//! format trait implementation to correctly adhere to the requested formatting parameters.
+//! The values of these parameters can be accessed with methods of the
 //! [`Formatter`] struct. In order to help with this, the [`Formatter`] struct also
 //! provides some helper methods.
 //!