forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove unnecessary doc string (#9481)

Browse Source 
# 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.
This commit is contained in:
lelo 2023-08-20 21:39:56 -04:00 committed by GitHub
parent 565316fc0d
commit ee0f2a713d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
crates/bevy_ui/src/node_bundles.rs
View File

@ -74,9 +74,6 @@ impl Default for NodeBundle {
#[derive(Bundle, Debug, Default)] #[derive(Bundle, Debug, Default)]
pub struct ImageBundle { pub struct ImageBundle {
/// Describes the logical size of the node /// 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, pub node: Node,
/// Styles which control the layout (size and position) of the node and it's children /// 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. /// In some cases these styles also affect how the node drawn/painted.
@ -98,12 +95,12 @@ pub struct ImageBundle {
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -117,9 +114,6 @@ pub struct ImageBundle {
#[derive(Bundle, Debug, Default)] #[derive(Bundle, Debug, Default)]
pub struct AtlasImageBundle { pub struct AtlasImageBundle {
/// Describes the logical size of the node /// 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, pub node: Node,
/// Styles which control the layout (size and position) of the node and it's children /// 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. /// In some cases these styles also affect how the node drawn/painted.
@ -143,12 +137,12 @@ pub struct AtlasImageBundle {
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -180,12 +174,12 @@ pub struct TextBundle {
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -292,12 +286,12 @@ pub struct ButtonBundle {
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// 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, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,