From e9671f3e9689199e97589a61d4ccaa787f60f8a0 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Tue, 5 Mar 2024 10:04:22 -0800 Subject: [PATCH] Fix docs for atlas + slicing support (#12325) # Objective The docs say that atlas and slicing are incompatible, but they are now compatible after https://github.com/bevyengine/bevy/pull/12059. ## Solution Update the docs. --- crates/bevy_sprite/src/bundle.rs | 6 ++---- crates/bevy_ui/src/node_bundles.rs | 12 ++++-------- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/crates/bevy_sprite/src/bundle.rs b/crates/bevy_sprite/src/bundle.rs index e0b4905697..0ad06f6afc 100644 --- a/crates/bevy_sprite/src/bundle.rs +++ b/crates/bevy_sprite/src/bundle.rs @@ -13,11 +13,9 @@ use bevy_transform::components::{GlobalTransform, Transform}; /// /// # Extra behaviours /// -/// You may add the following components to enable additional behaviours: +/// You may add one or both of the following components to enable additional behaviours: /// - [`ImageScaleMode`](crate::ImageScaleMode) to enable either slicing or tiling of the texture -/// - [`TextureAtlas`] to draw specific sections of the texture -/// -/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`. +/// - [`TextureAtlas`] to draw a specific section of the texture #[derive(Bundle, Clone, Debug, Default)] pub struct SpriteBundle { /// Specifies the rendering properties of the sprite, such as color tint and flip. diff --git a/crates/bevy_ui/src/node_bundles.rs b/crates/bevy_ui/src/node_bundles.rs index 29164c6e22..57b2bb4857 100644 --- a/crates/bevy_ui/src/node_bundles.rs +++ b/crates/bevy_ui/src/node_bundles.rs @@ -79,11 +79,9 @@ impl Default for NodeBundle { /// /// # Extra behaviours /// -/// You may add the following components to enable additional behaviours: +/// You may add one or both of the following components to enable additional behaviours: /// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture -/// - [`TextureAtlas`] to draw specific sections of the texture -/// -/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`. +/// - [`TextureAtlas`] to draw a specific section of the texture #[derive(Bundle, Debug, Default)] pub struct ImageBundle { /// Describes the logical size of the node @@ -298,11 +296,9 @@ where /// /// # Extra behaviours /// -/// You may add the following components to enable additional behaviours: +/// You may add one or both of the following components to enable additional behaviours: /// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture -/// - [`TextureAtlas`] to draw specific section of the texture -/// -/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`. +/// - [`TextureAtlas`] to draw a specific section of the texture #[derive(Bundle, Clone, Debug)] pub struct ButtonBundle { /// Describes the logical size of the node