Document every public item in bevy_ecs
#8731
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
JoJoJet
commented
Jun 3, 2023
JoJoJet
commented
Jun 3, 2023
JoJoJet
commented
Jun 3, 2023
JoJoJet
commented
Jun 3, 2023
mockersf
reviewed
Jun 3, 2023
mockersf
reviewed
Jun 3, 2023
nicopap
approved these changes
Jun 7, 2023
There was a problem hiding this comment.
LGTM excellent doc.
Minor nits:
- The first sentence in a doc string should be separated from the rest by an empty line
- I'd rather want to see doc strings not exceed the 80th column (I see this in a few place even if you generally keep them below 80 columns)
But it's a clear improvement regardless, so, to me, it looks good to merge.
Comment on lines
+253
to
+255
| /// Returns `true` if the underlying component type can be freely shared between threads. | ||
| /// If this returns `false`, then extra care must be taken to ensure that components | ||
| /// are not accessed from the wrong thread. |
There was a problem hiding this comment.
If I'm not mistaken, this is only relevant to Resources right? Since you can't have non-send components.
There was a problem hiding this comment.
Yes, resources are the only kind of component that can be !Send. ComponentInfo doesn't make a distinction between resource-components and entity-components, though.
nicopap
reviewed
Jun 7, 2023
JoJoJet
commented
Jun 9, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
45 tasks
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
Title.