Improve TextSpan docs
#17415
Merged
Improve TextSpan docs
#17415
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
669d1a9 to
63fba59
Compare
ickshonpe
reviewed
Jan 17, 2025
rparrett
added
S-Waiting-on-Author
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
BenjaminBrienen
added
the
D-Straightforward
mockersf
approved these changes
Feb 2, 2025
mockersf
reviewed
Feb 2, 2025
mockersf
reviewed
Feb 2, 2025
rparrett
force-pushed
the
textspan-docs
branch
from
4f8b87f to
c89e99c
Compare
mrchantey
pushed a commit
to mrchantey/bevy
that referenced
this pull request
Feb 4, 2025
# Objective Our [`TextSpan`](https://docs.rs/bevy/latest/bevy/prelude/struct.TextSpan.html) docs include a code example that does not actually "work." The code silently does not render anything, and the `Text*Writer` helpers fail. This seems to be by design, because we can't use `Text` or `Text2d` from `bevy_ui` or `bevy_sprite` within docs in `bevy_text`. (Correct me if I am wrong) I have seen multiple users confused by these docs. Also fixes bevyengine#16794 ## Solution Remove the code example from `TextSpan`, and instead encourage users to seek docs on `Text` or `Text2d`. Add examples with nested `TextSpan`s in those areas.
joshua-holmes
pushed a commit
to joshua-holmes/bevy
that referenced
this pull request
Feb 5, 2025
# Objective Our [`TextSpan`](https://docs.rs/bevy/latest/bevy/prelude/struct.TextSpan.html) docs include a code example that does not actually "work." The code silently does not render anything, and the `Text*Writer` helpers fail. This seems to be by design, because we can't use `Text` or `Text2d` from `bevy_ui` or `bevy_sprite` within docs in `bevy_text`. (Correct me if I am wrong) I have seen multiple users confused by these docs. Also fixes bevyengine#16794 ## Solution Remove the code example from `TextSpan`, and instead encourage users to seek docs on `Text` or `Text2d`. Add examples with nested `TextSpan`s in those areas.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
TextSpandocs include a code example that does not actually "work." The code silently does not render anything, and theText*Writerhelpers fail.This seems to be by design, because we can't use
TextorText2dfrombevy_uiorbevy_spritewithin 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 onTextorText2d.Add examples with nested
TextSpans in those areas.