Added note on need to call .drain to consume

alice-i-cecile · alice-i-cecile · commit 0d5185ede54f · 2021-05-11T18:44:26.000-04:00
diff --git a/crates/bevy_ecs/src/event.rs b/crates/bevy_ecs/src/event.rs
@@ -347,7 +347,7 @@ impl<'a, T: Component> EventReader<'a, T> {
     }
 }
 
-/// Reads and consumes all events of type T
+/// Reads and consumes all events of type T when .drain or .drain_with_id are called
 ///
 /// Useful for manual event cleanup when [AppBuilder::add_event::<T>] is omitted,
 /// allowing events to accumulate on your components or resources until consumed.

Original file line number	Diff line number	Diff line change
`@@ -347,7 +347,7 @@ impl<'a, T: Component> EventReader<'a, T> {`
`347`	`347`	`}`
`348`	`348`	`}`
`349`	`349`
`350`		`-/// Reads and consumes all events of type T`
	`350`	`+/// Reads and consumes all events of type T when .drain or .drain_with_id are called`
`351`	`351`	`///`
`352`	`352`	`/// Useful for manual event cleanup when [AppBuilder::add_event::<T>] is omitted,`
`353`	`353`	`/// allowing events to accumulate on your components or resources until consumed.`