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

Fix documentation of Entities::get #17721

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Fix documentation of Entities::get #17721

merged 1 commit into from
Feb 10, 2025

Conversation

urben1680
Copy link
Contributor

@urben1680 urben1680 commented Feb 7, 2025 •
edited
Loading

This method returns None if meta.location.archetype_id is ArchetypeId::INVALID.
EntityLocation::INVALID.archetype_id is ArchetypeId::INVALID.
Therefore this method cannot return Some(EntityLocation::INVALID).
Linking to it in the docs is futile anyway as that constant is not public.

@chescock chescock added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Feb 7, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Feb 10, 2025
Merged via the queue into bevyengine:main with commit 7f9588d Feb 10, 2025
32 checks passed
@urben1680 urben1680 deleted the entities_get_doc_fix branch February 10, 2025 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chescock chescock chescock approved these changes

@Carter0 Carter0 Carter0 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.
4 participants
@urben1680 @chescock @Carter0 @alice-i-cecile