-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Improve TextSpan
docs
#17415
Open
rparrett
wants to merge
5
commits into
bevyengine:main
Choose a base branch
from
rparrett:textspan-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Improve TextSpan
docs
#17415
+22
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rparrett
force-pushed
the
textspan-docs
branch
from
January 17, 2025 13:23
669d1a9
to
63fba59
Compare
ickshonpe
reviewed
Jan 17, 2025
rparrett
added
the
S-Waiting-on-Author
The author needs to make changes or address concerns before this can be merged
label
Jan 17, 2025
rparrett
added
C-Docs
An addition or correction to our documentation
A-Text
Rendering and layout for characters
S-Needs-Review
Needs reviewer attention (from anyone!) to move forward
and removed
S-Waiting-on-Author
The author needs to make changes or address concerns before this can be merged
labels
Jan 18, 2025
ickshonpe
reviewed
Jan 18, 2025
Carter0
approved these changes
Jan 18, 2025
ickshonpe
approved these changes
Jan 18, 2025
ickshonpe
added
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
and removed
S-Needs-Review
Needs reviewer attention (from anyone!) to move forward
labels
Jan 18, 2025
BenjaminBrienen
added
the
D-Straightforward
Simple bug fixes and API improvements, docs, test and examples
label
Jan 20, 2025
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
D-Straightforward
Simple bug fixes and API improvements, docs, test and examples
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Our
TextSpan
docs include a code example that does not actually "work." The code silently does not render anything, and theText*Writer
helpers fail.This seems to be by design, because we can't use
Text
orText2d
frombevy_ui
orbevy_sprite
within docs inbevy_text
. (Correct me if I am wrong)I have seen multiple users confused by these docs.
Also fixes #16794
Solution
Remove the code example from
TextSpan
, and instead encourage users to seek docs onText
orText2d
.Add examples with nested
TextSpan
s in those areas.