rewording

Co-Authored-By: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
bevyengine · Jun 1, 2022 · 5cf7a6a · 5cf7a6a
1 parent 03a9147
commit 5cf7a6a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/crates/bevy_diagnostic/src/diagnostic.rs b/crates/bevy_diagnostic/src/diagnostic.rs
@@ -104,7 +104,8 @@ impl Diagnostic {
  self.measurement().map(|measurement| measurement.value)
  }
 
- /// If this diagnostic has more than one value, return the average.
+ /// Return the mean (average) of this diagnostic's values.
+ /// N.B. this a cheap operation as the sum is cached.
  pub fn average(&self) -> Option<f64> {
  if !self.history.is_empty() {
  Some(self.sum / self.history.len() as f64)