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.

Sign up for GitHub

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

Jump to bottom

EntityMut::remove() needs better docs to explain behavior #5990

Closed
PROMETHIA-27 opened this issue Sep 15, 2022 · 0 comments
Closed

EntityMut::remove() needs better docs to explain behavior #5990

PROMETHIA-27 opened this issue Sep 15, 2022 · 0 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@PROMETHIA-27
Copy link
Contributor

It was recently mentioned in the discord that EntityMut::remove() has no docs, in particular whether it panics or not if the component the user attempted to remove is not present.
@PROMETHIA-27 PROMETHIA-27 added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events S-Needs-Triage This issue needs to be labelled labels Sep 15, 2022
@alice-i-cecile alice-i-cecile removed the S-Needs-Triage This issue needs to be labelled label Sep 16, 2022
@xgbwei xgbwei mentioned this issue Oct 4, 2022
Closed
@bors bors bot closed this as completed in 2a6b544 Oct 5, 2022
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 19, 2022
@xgbwei @james7132
Document EntityMut::remove() (bevyengine#6168)
0d3c8e7 
# Objective

- Fixes bevyengine#5990

## Solution

- Add docs for `EntityMut::remove()` explaining its return value.
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 28, 2022
@xgbwei @james7132
Document EntityMut::remove() (bevyengine#6168)
1b74d09 
# Objective

- Fixes bevyengine#5990

## Solution

- Add docs for `EntityMut::remove()` explaining its return value.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this issue Feb 1, 2023
@xgbwei @ItsDoot
Document EntityMut::remove() (bevyengine#6168)
8070425 
# Objective

- Fixes bevyengine#5990

## Solution

- Add docs for `EntityMut::remove()` explaining its return value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - Document EntityMut::remove() xgbwei/bevy
2 participants
@alice-i-cecile @PROMETHIA-27