Fix EntityCommands::despawn docs#13774
Merged
alice-i-cecile merged 1 commit intobevyengine:mainfrom Jun 9, 2024
Merged
Conversation
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Jun 9, 2024
alice-i-cecile
added
the
S-Ready-For-Final-Review
mockersf
pushed a commit
that referenced
this pull request
Jun 9, 2024
# Objective The `EntityCommands::despawn` method was previously changed from panicking behavior to a warning, but the docs continue to state that it panics. ## Solution - Removed panic section, copied warning blurb from `World::despawn` - Adds a similar warning blurb to `DespawnRecursiveExt::despawn_recursive` and `DespawnRecursiveExt::despawn_descendants`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
The
EntityCommands::despawnmethod was previously changed from panicking behavior to a warning, but the docs continue to state that it panics.Solution
World::despawnDespawnRecursiveExt::despawn_recursiveandDespawnRecursiveExt::despawn_descendants