Skip to content

Commit

Permalink
Closes #12386. Removed 'pub mod' doc-comments in std::io's mod.rs fil…
Browse files Browse the repository at this point in the history
…e. Added summary doc-comments to test.rs, util.rs and stdio.rs.
  • Loading branch information
zslayton committed Feb 23, 2014
1 parent 7cc6b5e commit 90f2d1d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 19 deletions.
14 changes: 0 additions & 14 deletions src/libstd/io/mod.rs
Expand Up @@ -215,46 +215,32 @@ pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream,
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
Expand Down
10 changes: 5 additions & 5 deletions src/libstd/io/stdio.rs
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/libstd/io/test.rs
Expand Up @@ -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;
Expand Down
2 changes: 2 additions & 0 deletions src/libstd/io/util.rs
Expand Up @@ -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;
Expand Down

5 comments on commit 90f2d1d

@bors
Copy link
Contributor

@bors bors commented on 90f2d1d Feb 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from alexcrichton
at zslayton@90f2d1d

@bors
Copy link
Contributor

@bors bors commented on 90f2d1d Feb 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging zslayton/rust/doc-fix-12386 = 90f2d1d into auto

@bors
Copy link
Contributor

@bors bors commented on 90f2d1d Feb 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zslayton/rust/doc-fix-12386 = 90f2d1d merged ok, testing candidate = 5737d1f

@bors
Copy link
Contributor

@bors bors commented on 90f2d1d Feb 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bors
Copy link
Contributor

@bors bors commented on 90f2d1d Feb 26, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = 5737d1f

Please sign in to comment.