-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
[Merged by Bors] - Basic documentation for Entities, Components and Systems #1578
Conversation
Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>
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.
I've got a bit carried away during reveiw. You don't have to agree with any of these changes; I'll list my reasons for them anyway.
Component
doc reads as subjective: "in a straightforward and efficient fashion", "is very simple", "commonly", "is known as"...
Components are not what stores - they are what is stored.
I understand the desire to use "if and only if", but "X
is Trait + OtherTrait
" is unambiguous, more popular in Rust docs, and allows for some seriously concise sentences.
It's not necessary to mention Rust. The users do, presumably, know what language they're working with.
I'm partial to dry and impersonal style - this is technical documentation, it should be as to the point as possible. It does have the unfortunate tendency to start all sentences the same way, though.
Trimmed lines to 100 symbols - this is what rustfmt
usually targets for code; maintaining that for comments and docs is not required, but I like it for consistency (and it removes the horizontal scrollbar in my IDE).
Co-authored-by: Alexander Sepity <ratysz@gmail.com>
Co-authored-by: Alexander Sepity <ratysz@gmail.com>
Co-authored-by: Alexander Sepity <ratysz@gmail.com>
I liked your changes a lot @Ratysz, and you're likely correct about tone, even if it's a bit drier than is perhaps ideal for certain audiences. We can save a more approachable tone for examples and the book. Very good idea to include a link to the docs on how to order systems in the I had expected |
Co-authored-by: Alexander Sepity <ratysz@gmail.com>
Looks good to me! |
bors r+ |
These are largely targeted at beginners, as `Entity`, `Component` and `System` are the most obvious terms to search when first getting introduced to Bevy.
Pull request successfully merged into main. Build succeeded: |
These are largely targeted at beginners, as
Entity
,Component
andSystem
are the most obvious terms to search when first getting introduced to Bevy.