Skip to content

Commit

Permalink
Rollup merge of #30591 - SimonSapin:patch-15, r=aturon
Browse files Browse the repository at this point in the history
The first line (paragraph?) of a doc-comment is what rustdoc shows when listing items of a module.

What makes `Instant` and `SystemTime` different is important enough to be there. (Though feel free to bikeshed the wording.)
  • Loading branch information
Manishearth committed Jan 15, 2016
2 parents a70a60a + 8e2b4b2 commit ad83ea6
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/libstd/time/mod.rs
Expand Up @@ -23,6 +23,7 @@ pub use self::duration::Duration;
mod duration;

/// A measurement of a monotonically increasing clock.
/// Opaque and useful only with `Duration`.
///
/// Instants are always guaranteed to be greater than any previously measured
/// instant when created, and are often useful for tasks such as measuring
Expand All @@ -42,8 +43,8 @@ mod duration;
#[unstable(feature = "time2", reason = "recently added", issue = "29866")]
pub struct Instant(time::Instant);

/// A measurement of the system clock appropriate for timestamps such as those
/// on files on the filesystem.
/// A measurement of the system clock, useful for talking to
/// external entities like the file system or other processes.
///
/// Distinct from the `Instant` type, this time measurement **is not
/// monotonic**. This means that you can save a file to the file system, then
Expand Down

0 comments on commit ad83ea6

Please sign in to comment.