auto merge of #12490 : zslayton/rust/doc-fix-12386, r=alexcrichton

Attn: @huonw

Addresses #12386.

diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 36d399476d9878562b4ea2839e1e10cdaae65925..4ffab7a5ef8712d8757932d479a260c2e6d6fa68 100644 (file)
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -214,46 +214,32 @@
                          LineBufferedWriter};
 pub use self::comm_adapters::{PortReader, ChanWriter};
 
-/// Various utility functions useful for writing I/O tests
 pub mod test;
 
-/// Synchronous, non-blocking filesystem operations.
 pub mod fs;
 
-/// Synchronous, in-memory I/O.
 pub mod pipe;
 
-/// Child process management.
 pub mod process;
 
-/// Synchronous, non-blocking network I/O.
 pub mod net;
 
-/// Readers and Writers for memory buffers and strings.
 mod mem;
 
-/// Non-blocking access to stdin, stdout, stderr
 pub mod stdio;
 
-/// Implementations for Result
 mod result;
 
-/// Extension traits
 pub mod extensions;
 
-/// Basic Timer
 pub mod timer;
 
-/// Buffered I/O wrappers
 mod buffered;
 
-/// Signal handling
 pub mod signal;
 
-/// Utility implementations of Reader and Writer
 pub mod util;
 
-/// Adapatation of Chan/Port types to a Writer/Reader type.
 mod comm_adapters;
 
 /// The default buffer size for various I/O operations

diff --git a/src/libstd/io/stdio.rs b/src/libstd/io/stdio.rs
index e1f0d87e130b6b3f9476b333403d79967d265009..b125fd69c5aec46a1203093b4dd7f369bde8f858 100644 (file)
--- a/src/libstd/io/stdio.rs
+++ b/src/libstd/io/stdio.rs
@@ -8,12 +8,12 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-/*!
+/*! Non-blocking access to stdin, stdout, and stderr.
 
-This modules provides bindings to the local event loop's TTY interface, using it
-to have synchronous, but non-blocking versions of stdio. These handles can be
-inspected for information about terminal dimensions or related information
-about the stream or terminal that it is attached to.
+This module provides bindings to the local event loop's TTY interface, using it
+to offer synchronous but non-blocking versions of stdio. These handles can be
+inspected for information about terminal dimensions or for related information
+about the stream or terminal to which it is attached.
 
 # Example
 

diff --git a/src/libstd/io/test.rs b/src/libstd/io/test.rs
index 4b499aa5c12ce01daa15e49149062b5d3decda69..c83dbe49b65b5b287958225efe5026b252414793 100644 (file)
--- a/src/libstd/io/test.rs
+++ b/src/libstd/io/test.rs
@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+/*! Various utility functions useful for writing I/O tests */
+
 #[macro_escape];
 
 use os;

diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs
index acaffd00665bf63a4797f832a02f855da6c763ee..d6d1de00d86e1266f9d794c2694de96ddd8844ab 100644 (file)
--- a/src/libstd/io/util.rs
+++ b/src/libstd/io/util.rs
@@ -8,6 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+/*! Utility implementations of Reader and Writer */
+
 use prelude::*;
 use cmp;
 use io;