Skip to content

Improve TextSpan documentation #20484

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve TextSpan documentation #20484

wants to merge 2 commits into from
+32 −24

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

viridia
viridia reviewed Aug 9, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@viridia viridia viridia approved these changes

@ickshonpe ickshonpe ickshonpe approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gwafotapa @viridia @ickshonpe