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

Update docstrings for text_system and text2d_system (#3732)

Browse Source 
# Objective

- Fixes #3562 

## Solution

- The outdated reference to `TextGlyphs` has been removed, and replaced with a more accurate docstring.

## What was `TextGlyphs`?
This is the real question of this Issue and PR. This is particulary interesting because not only is `TextGlyphs` not a type in bevy, but it _never was_. Indeed, this type never existed on main. Where did it come from?

`TextGlyphs` was originally a tuple struct wrapping a `Vec<PositionedGlyph>`. It was first introduced back in commit ec390aec4e in #765. At the time, position information was being stored on the text entities directly. However, after design review, [it was decided](https://github.com/bevyengine/bevy/pull/765#issuecomment-725047186) to instead store the glyphs in a `HashMap` owned by the `TextPipeline`. When this was done, the original type was not only removed, but abstracted behind a few layers of the `TextPipeline` API. Obviously, the original docstring wasn't updated accordingly.

Later, as part of #1122, the incorrect docstring was swept up when copy/pasting `text_system` for `text2d`. (Although I don't blame @CleanCut for this; it took me like 3 hours to track all this down to find the original context.)
This commit is contained in:
Rose Peck 2022-01-20 19:32:16 +00:00
parent cb2ba19d97
commit e30d600dbf
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
crates/bevy_text/src/text2d.rs
View File

@ -114,7 +114,8 @@ pub struct QueuedText2d {
entities: Vec<Entity>, entities: Vec<Entity>,
} }
/// Updates the `TextGlyphs` with the new computed glyphs from the layout /// Updates the layout and size information whenever the text or style is changed.
/// This information is computed by the `TextPipeline` on insertion, then stored.
#[allow(clippy::too_many_arguments, clippy::type_complexity)] #[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub fn text2d_system( pub fn text2d_system(
mut queued_text: Local<QueuedText2d>, mut queued_text: Local<QueuedText2d>,

4
crates/bevy_ui/src/widget/text.rs
View File

@ -34,8 +34,8 @@ pub fn text_constraint(min_size: Val, size: Val, max_size: Val, scale_factor: f6
} }
} }
/// Computes the size of a text block and updates the Text Glyphs with the /// Updates the layout and size information whenever the text or style is changed.
/// new computed glyphs from the layout /// This information is computed by the `TextPipeline` on insertion, then stored.
#[allow(clippy::too_many_arguments, clippy::type_complexity)] #[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub fn text_system( pub fn text_system(
mut queued_text: Local<QueuedText>, mut queued_text: Local<QueuedText>,