Clarify that Stopwatch.reset does not affect paused state (bevyengine…

…#6016) # Objective Makes `Stopwatch::reset` documentation more clear ## Solution Added a doc comment
james7132 · Oct 28, 2022 · a5c67ff · a5c67ff
1 parent 1918c46
commit a5c67ff
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/crates/bevy_time/src/stopwatch.rs b/crates/bevy_time/src/stopwatch.rs
@@ -186,7 +186,7 @@ impl Stopwatch {
         self.paused
     }
 
-    /// Resets the stopwatch.
+    /// Resets the stopwatch. The reset doesn’t affect the paused state of the stopwatch.
     ///
     /// # Examples
     /// ```

diff --git a/crates/bevy_time/src/timer.rs b/crates/bevy_time/src/timer.rs
@@ -292,7 +292,7 @@ impl Timer {
         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).
     ///