Skip to content
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

Update docs for Updated, Changed and Mutated #451

Merged
merged 2 commits into from
Sep 7, 2020
Merged

Conversation

BoxyUwU
Copy link
Member

@BoxyUwU BoxyUwU commented Sep 6, 2020

The wording feels a bit clunky to me but I can't think of a better way to write this.
Resolves #442

@cart
Copy link
Member

cart commented Sep 6, 2020

Yeah I agree that the wording is a little bit clunky, but for now this is still a nice improvement.

@BoxyUwU
Copy link
Member Author

BoxyUwU commented Sep 6, 2020

Oh I think I used the wrong ` or ' for one of these

@cart
Copy link
Member

cart commented Sep 6, 2020

Much nicer wording. Thanks!

@thlorenz
Copy link

thlorenz commented Sep 7, 2020

Nice! Just not seeing an explanation related to the behavior that could be unexpected, specifically (quoting from #442 )

changes are only detected in "downstream" systems

This may be too much to explain in comments, so maybe the book should?

@BoxyUwU
Copy link
Member Author

BoxyUwU commented Sep 7, 2020

Hmm, that's what the "since the start of the frame" was meant to convey, but if that isn't clear enough then it's probably worth rewording, or explicitly mentioning it.

@karroffel karroffel added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Sep 7, 2020
@cart
Copy link
Member

cart commented Sep 7, 2020

I think the current text is at the very least, a big improvement. You all are always welcome to add more docs in follow up prs 😄

@cart cart merged commit d86fae8 into bevyengine:master Sep 7, 2020
mrk-its pushed a commit to mrk-its/bevy that referenced this pull request Oct 6, 2020
Update docs for Updated, Changed and Mutated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changed/Added/Mutated queries not triggered depending on order of systems
4 participants