]> git.lizzy.rs Git - rust.git/commitdiff
Docs: clarify return value of std::io::Seek::seek
authorSimon Sapin <simon.sapin@exyr.org>
Sun, 2 Aug 2015 12:15:00 +0000 (14:15 +0200)
committerSimon Sapin <simon.sapin@exyr.org>
Sun, 2 Aug 2015 12:15:00 +0000 (14:15 +0200)
src/libstd/io/mod.rs

index f811aa1be4ee3133ac962bd50cd215831709b28a..3d746aa450a67acbd47bb3b2aad81b9dc00fbeb4 100644 (file)
@@ -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
     ///