bsn: improve docs and add tests#24464
Open
laundmo wants to merge 31 commits into
Open
Conversation
laundmo
commented
May 28, 2026
Member
Author
|
|
alice-i-cecile
added
C-Docs
alice-i-cecile
added
the
S-Waiting-on-Author
alice-i-cecile
added
S-Needs-Review
cart
reviewed
Jun 2, 2026
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Member
Author
|
@alice-i-cecile for the love of my notifications, please, make a single review with all your comments. |
| //! both would supply a [`FromTemplate`] impl and conflict. | ||
| //! You still have access to a default constructor of sorts though: the derive generates a companion | ||
| //! `YourTypeTemplate` struct that implements `Default`, so `YourTypeTemplate::default()` serves the same purpose. | ||
| //! For this reason, there is a custom "derive" which isn't actually a Trait, called [`VariantDefaults`](bevy_ecs::VariantDefaults) |
Member
There was a problem hiding this comment.
This is very confusing to read; I think we're leaking implementation details here.
Member
Author
There was a problem hiding this comment.
Perhaps, tho it feels like it needs to, otherwise people will go looking for the VariantDefaults trait which is just not a thing. I've tried re-wording it a bit.
| //! | ||
| //! For a quick rundown on how to read and write BSN syntax, | ||
| //! see the docs for [`bsn!`]. | ||
| //! We plan on making "conditional scenes" easier to define in future releases. |
Member
There was a problem hiding this comment.
Issue link would be nice, but I don't think one currently exists?
alice-i-cecile
requested changes
Jun 3, 2026
Member
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
A fair bit of clean up to do, but a marked improvement.
Moving from "inheritance" to "caching" has clarified a tremendous number of things for me.
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
laundmo
commented
Jun 3, 2026
Member
Author
|
Note: This PR does not include docs for any of the new features and syntax @cart made PRs for after I un-Draft-ed this. |
This was referenced Jun 6, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Improve documentation of bevy_scene/bsn.
Rendered: https://share.yadamiel.com/docs/doc/bevy/scene/index.html
Closes: #24299
Closes: #24540
Closes: #24541
Solution
This PR depends on/includes changes from
Docs changes (approx)
Inheritanceconcept in favour of cachingTesting
cargo doc -Zrustdoc-mergeable-info -p bevy_scene --liblocally works fineTodo