[Merged by Bors] - Improve WorldQuery docs
#5740
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>
Co-authored-by: James Liu <contact@jamessliu.com>
This will reflect the added context in this PR that is aware of what query items are and that they can be read-only or not.
Moved all links to the bottom of the doc comment. Links have been alphabetically ordered. Rebase notes: - After bevyengine#5205 got merged, the “Safety” section of `WorldQuery` has changed. I listed the mentioned methods for a better layout. I also removed the `WorldQuery::` prefix for readability. - I don't have enough knowledge of the previous and current state of `WorldQuery` types, so the documentation may be outdated somewhere. `WorldQuery` needs another review round.
Co-authored-by: Rob Parrett <robparrett@gmail.com>
Co-authored-by: Boxy <supbscripter@gmail.com>
afonsolage
suggested changes
Aug 19, 2022
Co-authored-by: Afonso Lage <lage.afonso@gmail.com>
Nilirad
added
C-Docs
afonsolage
approved these changes
Aug 19, 2022
Weibye
approved these changes
Aug 27, 2022
Weibye
added
the
S-Ready-For-Final-Review
ItsDoot
reviewed
Aug 31, 2022
| /// | ||
| /// There are many types that natively implement this trait: | ||
| /// | ||
| /// - **Component references.** |
There was a problem hiding this comment.
Suggested change
| /// - **Component references.** | |
| /// - **Component references (`&T` and `&mut T`).** |
Just to make it crystal clear what "Component references" mean.
| /// [`With`] and [`Without`] filters can be applied to check if the queried entity contains or not a particular component. | ||
| /// - **Change detection filters.** | ||
| /// [`Added`] and [`Changed`] filters can be applied to detect component changes to an entity. | ||
| /// - **Filter disjunction operator.** |
There was a problem hiding this comment.
Suggested change
| /// - **Filter disjunction operator.** | |
| /// - **[Filter disjunction operator](Or).** |
Might as well link directly to it from the start.
|
bors r+ |
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
WorldQuery docsWorldQuery docs
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
# Objective - Update docs to `WorldQuery` ## Solution - See bevyengine#4989. This PR is derived from it, and limited to the `WorldQuery` item docs.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective - Update docs to `WorldQuery` ## Solution - See bevyengine#4989. This PR is derived from it, and limited to the `WorldQuery` item docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
WorldQuerySolution
WorldQueryitem docs.