Skip to content

Commit 2195302

Browse files
committed
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.)
1 parent 27a1834 commit 2195302

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/libstd/time/mod.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ pub use self::duration::Duration;
2222

2323
mod duration;
2424

25-
/// A measurement of a monotonically increasing clock.
25+
/// A measurement of a monotonically increasing clock,
26+
/// only meaningful within one process.
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 appropriate for timestamps meaningful
47+
/// outside one process, such as those on files on the filesystem.
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)