bevyengine / bevy

A refreshingly simple data-driven game engine built in Rust

https://bevyengine.org

Apache License 2.0

36.46k stars 3.6k forks source link

Fix required components documentation ambiguity #16539

Closed IllyStable closed 10 hours ago

IllyStable commented 1 day ago

Objective

Fixes #16494

Solution

Changed depth first to breadth first (forgive me if I'm wrong, this is my first PR here and I'm fairly new to the Bevy codebase)

Testing

I don't believe testing was necessary - one word change

github-actions[bot] commented 1 day ago

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

IllyStable commented 1 day ago

Sorry about the one word change, didn't really know how to rephrase it to represent how required components actually propogate

alice-i-cecile commented 14 hours ago

I don't think that this is quite the right phrasing; it's quite subtle. I'll try and take a crack at this and make a suggestion here, then you tell me if it makes sense to you? :)

alice-i-cecile commented 13 hours ago

I've copied the wording from https://github.com/bevyengine/bevy/issues/16494#issuecomment-2499159496 directly for now. I think this is clearer and good enough to merge, but @IllyStable or @benfrankel may have a better suggestion.