Skip to content

Commit 42d41e3

Browse files
Doc - Link directly to DespawnOnEnter/Exit (#21650)
# Objective * Make DespawnOnExit more discoverable. * Fix broken link text - the parenthetical before it seems to mess it up. ## Solution * Link directly to DespawnOnExit from the module documentation instead of just the containing module. ## Testing None. Somebody should build the docs to make sure the links actually work (I'm 99% sure they do) and that the `\` added actually fixes the link on line 32 (I'm only 80% sure it does) ## Further Questions I'm wondering if this functionality should be listed in the bulleted list that precedes this paragraph. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
1 parent 3ca7b50 commit 42d41e3

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

crates/bevy_state/src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
//! - The [`in_state<S>`](crate::condition::in_state) and [`state_changed<S>`](crate::condition::state_changed) run conditions - which are used
3030
//! to determine whether a system should run based on the current state.
3131
//!
32-
//! Bevy also provides ("state-scoped entities") [`state_scoped`](`crate::state_scoped`) functionality for managing the lifetime of entities in the context of game states.
32+
//! Bevy also provides functionality for managing the lifetime of entities in the context of game states, using the [`state_scoped`] module.
33+
//! Specifically, the marker components [`DespawnOnEnter<S>`](crate::state_scoped::DespawnOnEnter) and [`DespawnOnExit<S>`](crate::state_scoped::DespawnOnExit) are provided for despawning entities on state transition.
3334
//! This, especially in combination with system scheduling, enables a flexible and expressive way to manage spawning and despawning entities.
3435
3536
#![cfg_attr(

0 commit comments

Comments
 (0)