Skip to content

Fix documentation of Entities::get#17721

Merged
alice-i-cecile merged 1 commit intobevyengine:mainfrom
urben1680:entities_get_doc_fix
Feb 10, 2025
Merged

Fix documentation of Entities::get#17721
alice-i-cecile merged 1 commit intobevyengine:mainfrom
urben1680:entities_get_doc_fix

Conversation

@urben1680
Copy link
Copy Markdown
Contributor

@urben1680 urben1680 commented Feb 7, 2025

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
@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

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.

4 participants