bevyengine / bevyengine/bevy

bevy::text::PositionedGlyph is undocumented, making it difficult to use.

Open
#8,972 0 comments 0 reactions 0 assignees View on GitHub
A-UI C-Docs
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
4d 8m
Merged PRs (30d)
147

Description

## How can Bevy's documentation be improved?

[`bevy::text::PositionedGlyph`](https://docs.rs/bevy/latest/bevy/text/struct.PositionedGlyph.html) has no documentation at all. This makes it difficult to know how the struct - or its containing struct, [`bevy::text::TextLayoutInfo`](https://docs.rs/bevy/latest/bevy/text/struct.TextLayoutInfo.html) - can be used.

For instance, I specifically need to access the layout information to know where to place an editor caret according to a glyph index that can change arbitrarily. I don't know whether `TextLayoutInfo` is suitable for this purpose, and neither does one of the maintainers; documenting the item in full would make it much simpler to find use-cases for it.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.