Skip to content

docs: enhance documentation in query.rs to clarify borrowing rules #17370

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
Merged
merged 5 commits into from
Jan 20, 2025
Merged

docs: enhance documentation in query.rs to clarify borrowing rules #17370

merged 5 commits into from
Jan 20, 2025

Conversation

younes-io
Copy link
Contributor

docs: enhance documentation in query.rs to clarify borrowing rules.

Please, let me know if you don't agree with the wording.. There is always room for improvement.

Tested locally and it looks like this:

image

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 14, 2025
alice-i-cecile
alice-i-cecile reviewed Jan 14, 2025
View reviewed changes
@BenjaminBrienen BenjaminBrienen added the D-Trivial Nice and easy! A great choice to get started with Bevy label Jan 15, 2025
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 15, 2025
@alice-i-cecile
Copy link
Member

This needs formatting before CI will let me merge it @younes-io :)

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 20, 2025
Merged via the queue into bevyengine:main with commit ebbd961 Jan 20, 2025
28 checks passed
mrchantey pushed a commit to mrchantey/bevy that referenced this pull request Feb 4, 2025
@younes-io @alice-i-cecile @mrchantey
docs: enhance documentation in query.rs to clarify borrowing rules (b…
957f6f6 
…evyengine#17370)

docs: enhance documentation in `query.rs` to clarify borrowing rules.

Please, let me know if you don't agree with the wording.. There is
always room for improvement.

Tested locally and it looks like this:


![image](https://github.com/user-attachments/assets/1283fcac-c5f7-426f-844f-fc2a12ce2b42)

---------

Co-authored-by: Alice Cecile <[email protected]>
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

+2 more reviewers

@Carter0 Carter0 Carter0 approved these changes

@BenjaminBrienen BenjaminBrienen BenjaminBrienen approved these changes

Reviewers whose approvals may not affect merge requirements
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 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
@younes-io @alice-i-cecile @Carter0 @BenjaminBrienen