UI node bundle comment fix#9404
Conversation
ickshonpe
changed the title
nicopap
added
C-Docs
rparrett
left a comment
rparrett
left a comment
There was a problem hiding this comment.
Checked the rendered docs. Looks good / makes sense to me.
While reviewing I noticed that the docs for the transform fields for these various bundles all make references to NodeBundle.
hymm
added
the
S-Ready-For-Final-Review
Weibye
left a comment
Weibye
left a comment
There was a problem hiding this comment.
I agree this is more correct 👍
Oh yep I see, better fix that too. |
|
Changed this line for the |
…form` field doc comment. Deleted the same line for `GlobalTransform` as it doesn't really make sense there.
…m/ickshonpe/bevy into ui-node-bundle-comment-correction
crates/bevy_ui/src/node_bundles.rs
Outdated
| /// | ||
| /// This field is automatically managed by the UI layout system. | ||
| /// This component is automatically managed by the UI layout system. | ||
| /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. |
There was a problem hiding this comment.
There's also a copy of this "NodeBundle" comment here, associated with the node field, with the same copy/paste mistake.
Seems safe to get rid of this one too to me. Not every bundle has it. But maybe it was intended that it say "to alter the size"?
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
@ickshonpe once merge conflicts are cleaned up, I'll merge this. |
# Objective Doc comment for the `global_transform` field in `NodeBundle` says: ``` /// This field is automatically managed by the UI layout system. ``` The `GlobalTransform` component is the thing being managed, not the `global_transform` field, and the `TransformPropagate` systems do the managing, not the UI layout system.
8 participants
Objective
Doc comment for the
global_transformfield inNodeBundlesays:The
GlobalTransformcomponent is the thing being managed, not theglobal_transformfield, and theTransformPropagatesystems do the managing, not the UI layout system.