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

iter_inner is either accidentally public or undocumented #5290

Closed
kornelski opened this issue Jul 11, 2022 · 3 comments
Closed

iter_inner is either accidentally public or undocumented #5290

kornelski opened this issue Jul 11, 2022 · 3 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation

Comments

@kornelski
Copy link
Contributor

The docs show iter_inner method, but this method has the exact same docstring as iter:

https://docs.rs/bevy/latest/bevy/ecs/system/struct.Query.html#method.iter_inner

@kornelski kornelski added C-Bug An unexpected or incorrect behavior S-Needs-Triage This issue needs to be labelled labels Jul 11, 2022
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels Jul 11, 2022
@tim-blackbird
Copy link
Contributor

Those docs do need to be updated but it's not the exact same.
iter_inner states "Returns an Iterator over the query results, with the actual “inner” world lifetime."

@alice-i-cecile alice-i-cecile removed the C-Bug An unexpected or incorrect behavior label Jul 11, 2022
@alice-i-cecile
Copy link
Member

Yeah, this could use a bit more context on why exactly you may want to use it.

@james7132
Copy link
Member

Following #5742, #4243, and #5591, the function seems to be pretty well documented. Closing.

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
Projects
None yet
Development

No branches or pull requests

4 participants