Update doc comments on Text2dBounds

bevyengine · Mar 29, 2022 · a52f3a2 · a52f3a2
1 parent ea31706
commit a52f3a2
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/crates/bevy_text/src/text2d.rs b/crates/bevy_text/src/text2d.rs
@@ -26,6 +26,11 @@ pub struct Text2dSize {
 }
 
 /// The maximum width and height of text. The text will wrap according to the specified size.
+/// Characters out of the bounds after wrapping will be truncated.
+///
+/// Note: only characters that are completely out of the bounds will be truncated, so this is not a
+/// reliable limit if it is necessary to contain the text strictly in the bounds. Currently this
+/// component is mainly useful for text wrapping only.
 #[derive(Component, Copy, Clone, Debug, Reflect)]
 #[reflect(Component)]
 pub struct Text2dBounds {