about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-03-23 15:10:55 -0700
committerAlex Crichton <alex@alexcrichton.com>2015-03-23 15:10:55 -0700
commitc99970783a30c94ac488d7f3bc28127fb1d32650 (patch)
tree8f875495028e067e37aa784d2a9345558ce5a070 /src/libstd
parent71c705db0207514b63bacd72afd61da2eb5720ef (diff)
parent90c8592889187681b9766b7507c090e180f61a78 (diff)
downloadrust-c99970783a30c94ac488d7f3bc28127fb1d32650.tar.gz
rust-c99970783a30c94ac488d7f3bc28127fb1d32650.zip
rollup merge of #23608: nagisa/refine-cursor-docstring
r? @steveklabnik
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/cursor.rs13
1 files changed, 5 insertions, 8 deletions
diff --git a/src/libstd/io/cursor.rs b/src/libstd/io/cursor.rs
index 0dde4642677..79f0af670b4 100644
--- a/src/libstd/io/cursor.rs
+++ b/src/libstd/io/cursor.rs
@@ -17,17 +17,14 @@ use iter::repeat;
 use num::Int;
 use slice;
 
-/// A `Cursor` is a type which wraps another I/O object to provide a `Seek`
+/// A `Cursor` is a type which wraps a non-I/O object to provide a `Seek`
 /// implementation.
 ///
-/// Cursors are currently typically used with memory buffer objects in order to
-/// allow `Seek` plus `Read` and `Write` implementations. For example, common
-/// cursor types include:
+/// Cursors are typically used with memory buffer objects in order to allow
+/// `Seek`, `Read`, and `Write` implementations. For example, common cursor types
+/// include `Cursor<Vec<u8>>` and `Cursor<&[u8]>`.
 ///
-/// * `Cursor<Vec<u8>>`
-/// * `Cursor<&[u8]>`
-///
-/// Implementations of the I/O traits for `Cursor<T>` are not currently generic
+/// Implementations of the I/O traits for `Cursor<T>` are currently not generic
 /// over `T` itself. Instead, specific implementations are provided for various
 /// in-memory buffer types like `Vec<u8>` and `&[u8]`.
 #[stable(feature = "rust1", since = "1.0.0")]