Added more documentation to world read / write methods. #312
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
Whilst there was already documentation explaining component / resource IDs, it was easy to skim over and no reference was made by the read_with_id and write_with_id methods. This made it seem like it expected an entity ID to search for a component, whereas in reality it's used for more complex component / resource setups.
torkleyy
approved these changes
Dec 7, 2017
|
Thank you! bors r+ |
bors bot
added a commit
that referenced
this pull request
Dec 7, 2017
312: Added more documentation to world read / write methods. r=torkleyy a=tomc1998 Whilst there was already documentation explaining component / resource IDs, it was easy to skim over and no reference was made by the read_with_id and write_with_id methods. This made it seem like it expected an entity ID to search for a component, whereas in reality it's used for more complex component / resource setups. This is meant to address #310 . <!-- 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/312) <!-- 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.
Whilst there was already documentation explaining component / resource
IDs, it was easy to skim over and no reference was made by the
read_with_id and write_with_id methods. This made it seem like it
expected an entity ID to search for a component, whereas in reality it's
used for more complex component / resource setups.
This is meant to address #310 .
This change is