From 1074a41b87fc3d18335844122cc55edc2453a2d2 Mon Sep 17 00:00:00 2001
From: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
Date: Fri, 14 Apr 2023 15:41:31 -0400
Subject: [PATCH] Fix docs for fixed timestep (#8363)

# Objective

The docs for `FixedTime::expend` are unfinished.
---
 crates/bevy_time/src/fixed_timestep.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/crates/bevy_time/src/fixed_timestep.rs b/crates/bevy_time/src/fixed_timestep.rs
index eaf2eb675d..f8df270565 100644
--- a/crates/bevy_time/src/fixed_timestep.rs
+++ b/crates/bevy_time/src/fixed_timestep.rs
@@ -65,7 +65,8 @@ impl FixedTime {
 
     /// Expends one `period` of accumulated time.
     ///
-    /// [`Err(FixedUpdateError`)] will be returned
+    /// [`Err(FixedUpdateError`)] will be returned if there is
+    /// not enough accumulated time to span an entire period.
     pub fn expend(&mut self) -> Result<(), FixedUpdateError> {
         if let Some(new_value) = self.accumulated.checked_sub(self.period) {
             self.accumulated = new_value;