bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #103466 - jruderman:patch-2, r=Dylan-DPC

Browse source 
Fix grammar in docs for std::io::Read

Two independent clauses were incorrectly joined by a bare comma. The simplest fix would be to switch to a semicolon, but I think it's slightly better to keep the comma and use the coordinating conjunction "so".
This commit is contained in:
Yuki Okushi 2022-10-24 19:32:29 +09:00 • committed by GitHub
commit a710f56e7d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
library/std/src/io/mod.rs
View file

@ -583,7 +583,7 @@ pub trait Read {
/// `n > buf.len()`. /// `n > buf.len()`.
/// ///
/// No guarantees are provided about the contents of `buf` when this /// No guarantees are provided about the contents of `buf` when this
/// function is called, implementations cannot rely on any property of the /// function is called, so implementations cannot rely on any property of the
/// contents of `buf` being true. It is recommended that *implementations* /// contents of `buf` being true. It is recommended that *implementations*
/// only write data to `buf` instead of reading its contents. /// only write data to `buf` instead of reading its contents.
/// ///
@ -759,7 +759,7 @@ pub trait Read {
/// specified buffer `buf`. /// specified buffer `buf`.
/// ///
/// No guarantees are provided about the contents of `buf` when this /// No guarantees are provided about the contents of `buf` when this
/// function is called, implementations cannot rely on any property of the /// function is called, so implementations cannot rely on any property of the
/// contents of `buf` being true. It is recommended that implementations /// contents of `buf` being true. It is recommended that implementations
/// only write data to `buf` instead of reading its contents. The /// only write data to `buf` instead of reading its contents. The
/// documentation on [`read`] has a more detailed explanation on this /// documentation on [`read`] has a more detailed explanation on this