Improve Join and Entities docs #313
Merged
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
WaDelma
reviewed
Dec 9, 2017
| @@ -66,6 +66,75 @@ bitset_and!{A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P} | |||
| /// The purpose of the `Join` trait is to provide a way | |||
| /// to access multiple storages at the same time with | |||
| /// the merged bit set. | |||
| /// | |||
| /// Joining component storages means that you'll only get values where | |||
| /// for a given entity every storage has an associated component. | |||
There was a problem hiding this comment.
Should we draw parallel to SQL? Or is that just confusing?
There was a problem hiding this comment.
I don't find it very useful tbh
Aceeri
suggested changes
Dec 10, 2017
src/join.rs
Outdated
| /// | ||
| /// let entities = world.read_resource::<EntitiesRes>(); | ||
| /// // note: `EntitiesRes` is the fetched resource; we get back | ||
| /// // `Fetch<EntitiesRes>` which has a typedef as `Entities`. |
There was a problem hiding this comment.
I feel like the Entities reference here is somewhat xonfusinf, maybe: "Fetch<EntitiesRes> can also be referred to by Entities which is a shorthand type definition to the former Fetch type."
src/world/mod.rs
Outdated
| /// let pos_storage = world.read::<Pos>(); | ||
| /// let vel_storage = world.read::<Vel>(); | ||
| /// | ||
| /// // `World::get` allows to get a component from it: |
src/lib.rs
Outdated
| @@ -251,7 +249,8 @@ pub use storage::{MergeError, PackedData}; | |||
| /// Please note that you should call `World::maintain` | |||
| /// after creating / deleting entities with this resource. | |||
| /// | |||
| /// When `.join`ing on `Entities`, you will need to do it like this: | |||
| /// When `.join`ing on `Entities`, you will need to do it like this | |||
There was a problem hiding this comment.
"When joining Entities you will need to first dereference Entities/Fetch<EntitiesRes> to get the underlying EntitiesRes, then you will need to re-reference it since only the referenced Entities has an implementation of Join."
|
Thanks, please review again. |
Aceeri
approved these changes
Dec 10, 2017
|
Thanks for reviewing! bors r+ |
bors bot
added a commit
that referenced
this pull request
Dec 10, 2017
313: Improve Join and Entities docs r=torkleyy a=torkleyy Fixes #307 <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/slide-rs/specs/313) <!-- Reviewable:end -->
Build succeeded |
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.
Fixes #307
This change is