Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix EntityCommands::despawn docs #13774

Merged
merged 1 commit into from
Jun 9, 2024

Conversation

thebluefish
Copy link
Contributor

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

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Jun 9, 2024
@alice-i-cecile alice-i-cecile added this to the 0.14 milestone Jun 9, 2024
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jun 9, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jun 9, 2024
Merged via the queue into bevyengine:main with commit 7c9c6ff Jun 9, 2024
31 checks passed
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`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants