Skip to content

Conversation

gwafotapa
Copy link
Contributor

Objective

The example in the documentation of TextSpan is wrong. It correctly states that Text or Text2d must be present but won't use either leading to no rendering. It also states that TextLayout, TextFont and TextColor of the first span will all set default values for the children, which is not true. TextLayout determines the layout of the block but each node has its own TextFont and TextColor which are both required components of TextSpan.

The type description is not clear about Text or Text2d being mandatory.

Solution

  • Fix the documentation

@alice-i-cecile alice-i-cecile added 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 A-Text Rendering and layout for characters labels Aug 13, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 13, 2025
Merged via the queue into bevyengine:main with commit 3fec4e0 Aug 13, 2025
38 checks passed
@gwafotapa gwafotapa deleted the text_span_documentation branch August 13, 2025 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Text Rendering and layout for characters 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.

4 participants