---

yaml
---
r: 65083
b: refs/heads/master
c: ebdb0de
h: refs/heads/master
i:
  65081: 53dbe69
  65079: af0e085
v: v3

Author: bors

[refs]

@@ -1,5 +1,5 @@
 ---
-refs/heads/master: 1065a92bf3bbe1f4bb11b7b7268a91529bbf8f89
+refs/heads/master: ebdb0dee272829f2410edd51acdb12f20721ce42
 refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
 refs/heads/snap-stage3: 18e3db7392d2d0697b7e27d6d986139960144d85
 refs/heads/try: 7b78b52e602bb3ea8174f9b2006bff3315f03ef9

trunk/src/libcore/io.rs

@@ -84,29 +84,25 @@ pub trait Reader {
 
     // FIXME (#2982): This should probably return an error.
     /**
-    * Reads bytes and puts them into `bytes`, advancing the cursor. Returns the
-    * number of bytes read.
+    * Reads bytes and puts them into `bytes`. Returns the number of
+    * bytes read.
     *
     * The number of bytes to be read is `len` or the end of the file,
     * whichever comes first.
     *
     * The buffer must be at least `len` bytes long.
     *
-    * `read` is conceptually similar to C's `fread`.
-    *
     * # Examples
     *
     * None right now.
     */
     fn read(&self, bytes: &mut [u8], len: uint) -> uint;
 
     /**
-    * Reads a single byte, advancing the cursor.
+    * Reads a single byte.
     *
     * In the case of an EOF or an error, returns a negative value.
     *
-    * `read_byte` is conceptually similar to C's `getc` function.
-    *
     * # Examples
     *
     * None right now.
@@ -116,8 +112,6 @@ pub trait Reader {
     /**
     * Returns a boolean value: are we currently at EOF?
     *
-    * `eof` is conceptually similar to C's `feof` function.
-    *
     * # Examples
     *
     * None right now.
@@ -130,8 +124,6 @@ pub trait Reader {
     * Takes an optional SeekStyle, which affects how we seek from the
     * position. See `SeekStyle` docs for more details.
     *
-    * `seek` is conceptually similar to C's `fseek`.
-    *
     * # Examples
     *
     * None right now.
@@ -141,8 +133,6 @@ pub trait Reader {
     /**
     * Returns the current position within the stream.
     *
-    * `tell` is conceptually similar to C's `ftell` function.
-    *
     * # Examples
     *
     * None right now.
@@ -1020,6 +1010,16 @@ pub fn FILE_reader(f: *libc::FILE, cleanup: bool) -> @Reader {
 // top-level functions that take a reader, or a set of default methods on
 // reader (which can then be called reader)
 
+/**
+* Gives a `Reader` that allows you to read values from standard input.
+*
+* # Examples
+* ~~~
+* let stdin = core::io::stdin();
+* let line = stdin.read_line();
+* core::io::print(line);
+* ~~~
+*/
 pub fn stdin() -> @Reader {
     unsafe {
         @rustrt::rust_get_stdin() as @Reader