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

Improve EntityWorldMut.remove, retain and despawn docs by linking to more detail #10943

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Improve EntityWorldMut.remove, retain and despawn docs by linking to more detail #10943

merged 2 commits into from
Dec 12, 2023

Conversation

13ros27
Copy link
Contributor

@13ros27 13ros27 commented Dec 12, 2023

Solution

Commands.remove and .retain (because I copied removes doc) referenced EntityWorldMut.remove and retain for more detail but the Commands docs are much more detailed (which makes sense because it is the most common api), so I have instead inverted this so that EntityWorldMut docs link to Commands.

I also made EntityWorldMut.despawn reference World.despawn for more details, like Commands.despawn does.

@13ros27
Add 'See World::despawn for more details' to `EntityWorldMut::despawn…
dc2cc6a 
…` to match `Commands::despawn.`
@13ros27
Changed from linking Commands.remove and Commands.retain to their wor…
3456976 
…ld equivalents to the other way around because the commands api has far more doc detail.
@Nilirad Nilirad added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Dec 12, 2023
@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 Dec 12, 2023
@alice-i-cecile
Copy link
Member

Merging as trivial, thanks!

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Dec 12, 2023
Merged via the queue into bevyengine:main with commit 6a15ed5 Dec 12, 2023
26 checks passed
@13ros27 13ros27 deleted the commands_docs_cleanup branch January 1, 2024 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@13ros27 @alice-i-cecile @Nilirad