From: Simon Sapin Date: Sun, 2 Aug 2015 12:15:00 +0000 (+0200) Subject: Docs: clarify return value of std::io::Seek::seek X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=7b2dd1fb281dab2543f619a52bc8c217d3ed7700;p=rust.git Docs: clarify return value of std::io::Seek::seek --- diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index f811aa1be4e..3d746aa450a 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -1060,8 +1060,9 @@ pub trait Seek { /// The behavior when seeking past the end of the stream is implementation /// defined. /// - /// This method returns the new position within the stream if the seek - /// operation completed successfully. + /// If the seek operation completed successfully, + /// this method returns the new position from the start of the stream. + /// That position can be used later with `SeekFrom::Start`. /// /// # Errors ///