From ee0f2a713d65c9912cfa27f932db137c8a744cd5 Mon Sep 17 00:00:00 2001 From: lelo <15314665+hate@users.noreply.github.com> Date: Sun, 20 Aug 2023 21:39:56 -0400 Subject: [PATCH] Remove unnecessary doc string (#9481) # Objective - Resolves https://github.com/bevyengine/bevy/issues/9440 ## Solution - Remove the doc string mentioning the position of a `NodeBundle`, since the doc string for the `style` component already explains this ability. --- crates/bevy_ui/src/node_bundles.rs | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/crates/bevy_ui/src/node_bundles.rs b/crates/bevy_ui/src/node_bundles.rs index a8c82a4828893..84f7940fe1734 100644 --- a/crates/bevy_ui/src/node_bundles.rs +++ b/crates/bevy_ui/src/node_bundles.rs @@ -74,9 +74,6 @@ impl Default for NodeBundle { #[derive(Bundle, Debug, Default)] pub struct ImageBundle { /// Describes the logical size of the node - /// - /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. pub node: Node, /// Styles which control the layout (size and position) of the node and it's children /// In some cases these styles also affect how the node drawn/painted. @@ -98,12 +95,12 @@ pub struct ImageBundle { /// The transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `ImageBundle`, use the properties of the [`Style`] component. pub transform: Transform, /// The global transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `ImageBundle`, use the properties of the [`Style`] component. pub global_transform: GlobalTransform, /// Describes the visibility properties of the node pub visibility: Visibility, @@ -117,9 +114,6 @@ pub struct ImageBundle { #[derive(Bundle, Debug, Default)] pub struct AtlasImageBundle { /// Describes the logical size of the node - /// - /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. pub node: Node, /// Styles which control the layout (size and position) of the node and it's children /// In some cases these styles also affect how the node drawn/painted. @@ -143,12 +137,12 @@ pub struct AtlasImageBundle { /// The transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `AtlasImageBundle`, use the properties of the [`Style`] component. pub transform: Transform, /// The global transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `AtlasImageBundle`, use the properties of the [`Style`] component. pub global_transform: GlobalTransform, /// Describes the visibility properties of the node pub visibility: Visibility, @@ -180,12 +174,12 @@ pub struct TextBundle { /// The transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `TextBundle`, use the properties of the [`Style`] component. pub transform: Transform, /// The global transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `TextBundle`, use the properties of the [`Style`] component. pub global_transform: GlobalTransform, /// Describes the visibility properties of the node pub visibility: Visibility, @@ -292,12 +286,12 @@ pub struct ButtonBundle { /// The transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `ButtonBundle`, use the properties of the [`Style`] component. pub transform: Transform, /// The global transform of the node /// /// This field is automatically managed by the UI layout system. - /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. + /// To alter the position of the `ButtonBundle`, use the properties of the [`Style`] component. pub global_transform: GlobalTransform, /// Describes the visibility properties of the node pub visibility: Visibility,