diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2016-01-15 17:28:28 +0530 |
|---|---|---|
| committer | Manish Goregaokar <manishsmail@gmail.com> | 2016-01-15 17:28:28 +0530 |
| commit | ad83ea6a6554dfc837a8e42c1af8af093d98c63d (patch) | |
| tree | 63097c39b529ca7654b217751865b3bf916bc1b5 /src/libstd | |
| parent | a70a60a02bca4c1fb75a0eb0ecf80acb73972f66 (diff) | |
| parent | 8e2b4b291127d882d65ae0ffd84ff7138c08bae6 (diff) | |
| download | rust-ad83ea6a6554dfc837a8e42c1af8af093d98c63d.tar.gz rust-ad83ea6a6554dfc837a8e42c1af8af093d98c63d.zip | |
Rollup merge of #30591 - SimonSapin:patch-15, r=aturon
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.)
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/time/mod.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libstd/time/mod.rs b/src/libstd/time/mod.rs index e3ce8e0de4b..f885733c2d1 100644 --- a/src/libstd/time/mod.rs +++ b/src/libstd/time/mod.rs @@ -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 @@ -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 |
