OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Instant/SystemTime doc: add meaning to first line

Browse Source 
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.)
This commit is contained in:
Simon Sapin 2015-12-28 19:52:42 +00:00
parent 27a1834ce5
commit 219530290a
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/libstd/time/mod.rs
View File

@ -22,7 +22,8 @@ pub use self::duration::Duration;
mod duration;
/// A measurement of a monotonically increasing clock.
/// A measurement of a monotonically increasing clock,
/// only meaningful within one process.
///
/// Instants are always guaranteed to be greater than any previously measured
/// instant when created, and are often useful for tasks such as measuring
@ -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 appropriate for timestamps meaningful
/// outside one process, such as those on files on the filesystem.
///
/// Distinct from the `Instant` type, this time measurement **is not
/// monotonic**. This means that you can save a file to the file system, then