bevy/crates
Rose Peck e30d600dbf Update docstrings for text_system and text2d_system (#3732)
# 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.)
2022-01-20 19:32:16 +00:00
..
bevy_app Document sub apps (#3403) 2022-01-14 23:14:42 +00:00
bevy_asset Enable the doc_markdown clippy lint (#3457) 2022-01-09 23:20:13 +00:00
bevy_audio Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_core Change bevy_core::Name to implement Deref<Target = str> (#3681) 2022-01-17 21:30:17 +00:00
bevy_core_pipeline Add headless mode (#3439) 2022-01-08 10:39:43 +00:00
bevy_crevice Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_derive Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_diagnostic Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_dylib Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_dynamic_plugin Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_ecs Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_ecs_compile_fail_tests Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_gilrs Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_gltf Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_input Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_internal Enable the doc_markdown clippy lint (#3457) 2022-01-09 23:20:13 +00:00
bevy_log Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_macro_utils Don't panic in macro shape validation (#3647) 2022-01-15 22:14:43 +00:00
bevy_math Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_pbr bevy_pbr: Do not panic when more than 256 point lights are added the scene (#3697) 2022-01-17 22:22:15 +00:00
bevy_reflect document more of bevy_reflect (#3655) 2022-01-14 19:09:44 +00:00
bevy_render rename Texture to Image in doc of from_buffer function (#3713) 2022-01-18 01:28:09 +00:00
bevy_scene Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_sprite Add headless mode (#3439) 2022-01-08 10:39:43 +00:00
bevy_tasks Document bevy_tasks and enable #![warn(missing_docs)] (#3509) 2022-01-16 04:53:22 +00:00
bevy_text Update docstrings for text_system and text2d_system (#3732) 2022-01-20 19:32:16 +00:00
bevy_transform Added docs for bevy_transform (#3516) 2022-01-14 18:47:48 +00:00
bevy_ui Update docstrings for text_system and text2d_system (#3732) 2022-01-20 19:32:16 +00:00
bevy_utils Release 0.6.0 (#3587) 2022-01-08 10:18:22 +00:00
bevy_window Enable the doc_markdown clippy lint (#3457) 2022-01-09 23:20:13 +00:00
bevy_winit do not set cursor grab on window creation if not asked for (#3617) 2022-01-15 20:29:58 +00:00