Skip to content

Document Fetch, Access and related types for bevy_ecs #3386

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
Closed
wants to merge 7 commits into from
Closed

Document Fetch, Access and related types for bevy_ecs #3386

wants to merge 7 commits into from

Conversation

alice-i-cecile
Copy link
Member

Objective

  • These types are important to bevy_ecs devs and not self-explanatory.

Solution

  • Document them!

@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 mentioned this pull request Dec 19, 2021
Closed
@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
@alice-i-cecile
Copy link
Member Author

By @DJMcNab from #3366 on Archetype.

With sparse set components, these can contain many sets of component, although each set is uniquely assigned to a single archetype.

I'm not entirely sure how to explain this cleanly, so help would be appreciated.

Weibye
Weibye approved these changes May 28, 2022
View reviewed changes
Copy link
Contributor

@Weibye Weibye left a comment

Choose a reason for hiding this comment

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

Thanks, this is great and very helpful to someone not already familiar with all of this

crates/bevy_ecs/src/query/fetch.rs
@@ -232,7 +246,7 @@ impl<T: Component> WorldQuery for &T {
type ReadOnlyFetch = ReadFetch<T>;
}

/// The [`FetchState`] of `&T`.
/// The [`FetchState`] of `&T`, when used as a [Component] in a [WorldQuery].
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a difference between [StructDefinition] and [`StructDefinition`] when it comes to what is being linked / how it is rendered in the rust-docs?

Copy link
Member Author

Choose a reason for hiding this comment

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

The latter will be shown in code-style monospace text.

Copy link
Contributor

Choose a reason for hiding this comment

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

Gotcha, thanks!

@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; I don't care enough to fix the merge conflicts. These can be rewritten in further PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Weibye Weibye Weibye approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alice-i-cecile @Weibye