Skip to content

Commit ad83ea6

Browse files
committed
Rollup merge of rust-lang#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.)
2 parents a70a60a + 8e2b4b2 commit ad83ea6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/libstd/time/mod.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ pub use self::duration::Duration;
2323
mod duration;
2424

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

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

0 commit comments

Comments
 (0)