Skip to content

Commit

Permalink
docs(client): make it clear what Read for Response reads
Browse files Browse the repository at this point in the history
In case someone reads the documentation for `client::Response`
without having read the documentation for the `client` module
first, they might wonder what the `Read` impl actually reads.
Let's clarify it by annotating the `Read` impl.
  • Loading branch information
crumblingstatue authored and seanmonstar committed May 29, 2016
1 parent ce0b62e commit c7a513e
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/client/response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ impl Response {
}
}

/// Read the response body.
impl Read for Response {
#[inline]
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
Expand Down

0 comments on commit c7a513e

Please sign in to comment.