From 219530290a1fcd3f159336fa6acf4b4e7d2c3a30 Mon Sep 17 00:00:00 2001 From: Simon Sapin Date: Mon, 28 Dec 2015 19:52:42 +0000 Subject: Instant/SystemTime doc: add meaning to first line 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.) --- src/libstd/time/mod.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src/libstd') diff --git a/src/libstd/time/mod.rs b/src/libstd/time/mod.rs index e3ce8e0de4b..6ee867fd0da 100644 --- a/src/libstd/time/mod.rs +++ b/src/libstd/time/mod.rs @@ -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 -- cgit 1.4.1-3-g733a5