Skip to content

Commit

Permalink
docs: remove unneeded doc from AsyncReadExt::read_ext() (#2621)
Browse files Browse the repository at this point in the history
This paragraph from `std::io::Read::read_ext()` applies to
*implementors* of `Read`. Since `AsyncReadExt` can't and shouldn't be
implemented outside of this crate, this documentation is unnecessary.
  • Loading branch information
jebrosen authored Jun 18, 2020
1 parent a43ec11 commit 0ab2862
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions tokio/src/io/util/async_read_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -238,12 +238,6 @@ cfg_io_util! {
/// This function reads as many bytes as necessary to completely fill
/// the specified buffer `buf`.
///
/// No guarantees are provided about the contents of `buf` when this
/// function is called, implementations cannot rely on any property of
/// the contents of `buf` being `true`. It is recommended that
/// implementations only write data to `buf` instead of reading its
/// contents.
///
/// # Errors
///
/// If the operation encounters an "end of file" before completely
Expand Down

0 comments on commit 0ab2862

Please sign in to comment.