Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved text widget doc comments #9344

Merged
merged 2 commits into from
Aug 5, 2023

Conversation

ickshonpe
Copy link
Contributor

Objective

The doc comment for text_system is not quite correct. It implies that a new TextLayoutInfo is generated on changes to Text and Style. While changes to those components might indirectly trigger a regeneration of the text layout, text_system itself only queries for changes to Node

Also added details to measure_text_system's doc comments explaining how it reacts to changes.

…at a new `TextLayoutInfo` is generated on changes to `Text` and `Style`. While changes to those components may indirectly trigger a regeneration of the text layout, `text_system` itself only queries for changes to `Node`

Also added details to `measure_text_system`'s doc comments explaining how it reacts to changes.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-UI Graphical user interfaces, styles, layouts, and widgets labels Aug 3, 2023
Co-authored-by: François <mockersf@gmail.com>
@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 4, 2023
@mockersf mockersf added this pull request to the merge queue Aug 5, 2023
Merged via the queue into bevyengine:main with commit e52af83 Aug 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-UI Graphical user interfaces, styles, layouts, and widgets C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants