Add caveat about the monotonicity guarantee by linking to the later section
This commit is contained in:
parent
9d8ef11607
commit
bda2693e9b
1 changed files with 4 additions and 2 deletions
|
@ -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
|
||||
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue