Skip to content

More docs for Query internals#3387

Closed
alice-i-cecile wants to merge 4 commits intobevyengine:mainfrom
alice-i-cecile:query-docs
Closed

More docs for Query internals#3387
alice-i-cecile wants to merge 4 commits intobevyengine:mainfrom
alice-i-cecile:query-docs

Conversation

@alice-i-cecile
Copy link
Member

Objective

  • Needs more docs.

Solution

  • Add more docs!

@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Dec 19, 2021
@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation and removed S-Needs-Triage This issue needs to be labelled labels Dec 19, 2021
Comment on lines +297 to +299
/// `And` is the default behavior:
/// adding mutliple filters as a tuple to the second type parameter of [Query](crate::system::Query)
/// will only return an entity if all of the applied filters are met.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this is were how to do And is documented, it could use a #[doc(alias = "and")]

@alice-i-cecile alice-i-cecile added the S-Adopt-Me The original PR author has no intent to complete this work. Pick me up! label Jun 26, 2022
@alice-i-cecile
Copy link
Member Author

Closing because associated machinery has changed enough that I'm not comfortable merging this.

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-Adopt-Me The original PR author has no intent to complete this work. Pick me up!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants