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

JohnTheCoolingFan · JohnTheCoolingFan · commit 1f0fa5908a46 · 2022-09-18T23:36:05.000Z
# Objective

Makes `Stopwatch::reset` documentation more clear

## Solution

Added a doc comment
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).
     ///

Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ impl Stopwatch {`
`186`	`186`	`self.paused`
`187`	`187`	`}`
`188`	`188`
`189`		`- /// Resets the stopwatch.`
	`189`	`+ /// Resets the stopwatch. The reset doesn’t affect the paused state of the stopwatch.`
`190`	`190`	`///`
`191`	`191`	`/// # Examples`
`192`	`192`	/// ```
Original file line number	Diff line number	Diff line change
`@@ -292,7 +292,7 @@ impl Timer {`
`292`	`292`	`self.stopwatch.paused()`
`293`	`293`	`}`
`294`	`294`
`295`		- /// Resets the timer. the reset doesn't affect the `paused` state of the timer.
	`295`	+ /// Resets the timer. The reset doesn't affect the `paused` state of the timer.
`296`	`296`	`///`
`297`	`297`	/// See also [`Stopwatch::reset`](Stopwatch::reset).
`298`	`298`	`///`