Add docs to bevy_sprite a little #10947
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
nicopap
added
C-Docs
alice-i-cecile
requested changes
Dec 12, 2023
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
|
Thanks, applied suggestions. |
alice-i-cecile
approved these changes
Dec 13, 2023
Nilirad
suggested changes
Dec 13, 2023
crates/bevy_sprite/src/lib.rs
Outdated
| #[derive(Default)] | ||
| pub struct SpritePlugin; | ||
|
|
||
| pub const SPRITE_SHADER_HANDLE: Handle<Shader> = Handle::weak_from_u128(2763343953151597127); | ||
|
|
||
| /// Set system for the systems relating to sprite rendering. |
There was a problem hiding this comment.
Suggested change
| /// Set system for the systems relating to sprite rendering. | |
| /// System labels for sprite rendering. |
The wording is a little weird and "set system" is not a common form.
There was a problem hiding this comment.
Suggested change
| /// Set system for the systems relating to sprite rendering. | |
| /// System set for sprite rendering. |
Alternative version.
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
Nilirad
approved these changes
Dec 14, 2023
hymm
added
the
S-Ready-For-Final-Review
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
Spritebeing undocumented was especially confusing for me even though it is one of the first types I need to learn.Solution
I'm unsure about my understanding of functionality and writing. I'm happy to be pointed out any mistakes.