Skip to content

Commit

Permalink
Add caveat about the monotonicity guarantee by linking to the later s…
Browse files Browse the repository at this point in the history
…ection
  • Loading branch information
the8472 committed Feb 13, 2022
1 parent 9d8ef11 commit bda2693
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions library/std/src/time.rs
Expand Up @@ -49,8 +49,8 @@ pub use core::time::FromFloatSecsError;
/// A measurement of a monotonically nondecreasing clock.
/// Opaque and useful only with [`Duration`].
///
/// Instants are always guaranteed to be no less than any previously measured
/// instant when created, and are often useful for tasks such as measuring
/// Instants are always guaranteed, barring [platform bugs], to be no less than any previously
/// measured instant when created, and are often useful for tasks such as measuring
/// benchmarks or timing how long an operation takes.
///
/// Note, however, that instants are **not** guaranteed to be **steady**. In other
Expand Down Expand Up @@ -83,6 +83,8 @@ pub use core::time::FromFloatSecsError;
/// }
/// ```
///
/// [platform bugs]: Instant#monotonicity
///
/// # OS-specific behaviors
///
/// An `Instant` is a wrapper around system-specific types and it may behave
Expand Down

0 comments on commit bda2693

Please sign in to comment.