about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2019-06-25 22:59:00 +0200
committerRalf Jung <post@ralfj.de>2019-06-25 22:59:00 +0200
commit390f717a0af5851271792da9ff235c95f3db2556 (patch)
tree6fbeb678794fba5d42e4fbb6d65285d39911c2c3 /src/libstd
parent1c12b1be330dd9c3de0b4fe599686d7c0c45e720 (diff)
downloadrust-390f717a0af5851271792da9ff235c95f3db2556.tar.gz
rust-390f717a0af5851271792da9ff235c95f3db2556.zip
tweak wording
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/mod.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 7fba844897f..3d0568c16cd 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -509,10 +509,10 @@ pub trait Read {
     /// contents of `buf` being true. It is recommended that *implementations*
     /// only write data to `buf` instead of reading its contents.
     ///
-    /// Correspondingly, however, *users* of this trait may not assume any guarantees
+    /// Correspondingly, however, *callers* of this method may not assume any guarantees
     /// about how the implementation uses `buf`. The trait is safe to implement,
-    /// so it is perfectly possible that the implementation might inspect that data.
-    /// As a caller, it is your responsibility to make sure that `buf` is initialized
+    //  so it is possible that the code that's supposed to write to the buffer might also read
+    //  from it. It is your responsibility to make sure that `buf` is initialized
     /// before calling `read`. Calling `read` with an uninitialized `buf` (of the kind one
     /// obtains via [`MaybeUninit<T>`]) is not safe, and can lead to undefined behavior.
     ///