Skip to content

Commit

Permalink
Add link to Text2dBundle in TextBundle docs. (bevyengine#9900)
Browse files Browse the repository at this point in the history
# Objective

Some beginners spend time trying to manually set the position of a
`TextBundle`, without realizing that `Text2dBundle` exists.

## Solution

Mention `Text2dBundle` in the documentation of `TextBundle`.

---------

Co-authored-by: Rob Parrett <robparrett@gmail.com>
  • Loading branch information
2 people authored and Ray Redondo committed Jan 9, 2024
1 parent fc442dc commit f867cc3
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions crates/bevy_ui/src/node_bundles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ pub struct AtlasImageBundle {

#[cfg(feature = "bevy_text")]
/// A UI node that is text
///
/// The positioning of this node is controlled by the UI layout system. If you need manual control,
/// use [`Text2dBundle`](bevy_text::Text2dBundle).
#[derive(Bundle, Debug)]
pub struct TextBundle {
/// Describes the logical size of the node
Expand Down

0 comments on commit f867cc3

Please sign in to comment.