-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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.
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
Add docs to bevy_sprite a little #10947
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great progress, some suggestions :)
Co-authored-by: Alice Cecile <[email protected]>
Thanks, applied suggestions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It just needs a some changes to improve correctness and consistency. For the rest it is OK.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Set system for the systems relating to sprite rendering. | |
/// System set for sprite rendering. |
Alternative version.
Co-authored-by: Federico Rinaldi <[email protected]>
Objective
Sprite
being 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.