Clarify that Stopwatch.reset does not affect paused state (#6016)

# Objective

Makes `Stopwatch::reset` documentation more clear

## Solution

Added a doc comment
This commit is contained in:
JohnTheCoolingFan 2022-09-18 23:36:05 +00:00
parent 53157c0801
commit 1f0fa5908a
2 changed files with 2 additions and 2 deletions

View file

@ -186,7 +186,7 @@ impl Stopwatch {
self.paused self.paused
} }
/// Resets the stopwatch. /// Resets the stopwatch. The reset doesnt affect the paused state of the stopwatch.
/// ///
/// # Examples /// # Examples
/// ``` /// ```

View file

@ -292,7 +292,7 @@ impl Timer {
self.stopwatch.paused() self.stopwatch.paused()
} }
/// Resets the timer. the reset doesn't affect the `paused` state of the timer. /// Resets the timer. The reset doesn't affect the `paused` state of the timer.
/// ///
/// See also [`Stopwatch::reset`](Stopwatch::reset). /// See also [`Stopwatch::reset`](Stopwatch::reset).
/// ///