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

Add some more docs for bevy_text. #9873

Merged

Conversation

waywardmonkeys
Copy link
Contributor

@waywardmonkeys waywardmonkeys commented Sep 20, 2023

Objective

  • Have more docs for bevy_text to avoid reading the source code for some things.

Solution

  • Add some additional docs.

Changelog

  • TextSettings.max_font_atlases in bevy_text has been renamed to TextSettings.soft_max_font_atlases.

Migration Guide

  • Usages of TextSettings.max_font_atlases from bevy_text must be changed to TextSettings.soft_max_font_atlases.

@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 Sep 29, 2023
@waywardmonkeys waywardmonkeys force-pushed the bevy-text-doc-additions branch from 3ad819d to cf7630c Compare October 16, 2023 17:07
@alice-i-cecile alice-i-cecile added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Oct 16, 2023
@waywardmonkeys
Copy link
Contributor Author

Sorry for the delay in addressing the feedback here. I think I've done it now though.

@waywardmonkeys waywardmonkeys force-pushed the bevy-text-doc-additions branch from cf7630c to 5ddd715 Compare October 17, 2023 02:13
@alice-i-cecile
Copy link
Member

By the way, in the future can you make more commits rather than amending and force-pushing when addressing feedback? Not a big deal, but it makes it much easier to check how the feedback was addressed and we squash on merge anyways.

@waywardmonkeys
Copy link
Contributor Author

Just checking in on this to see if there's anything left for me to do.

@alice-i-cecile
Copy link
Member

Nothing else: let me try and wrangle a second reviewer :)

@alice-i-cecile alice-i-cecile 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 Oct 27, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 27, 2023
Merged via the queue into bevyengine:main with commit 0db999c Oct 27, 2023
22 checks passed
@waywardmonkeys waywardmonkeys deleted the bevy-text-doc-additions branch October 28, 2023 00:55
ameknite pushed a commit to ameknite/bevy that referenced this pull request Nov 6, 2023
# Objective

- Have more docs for `bevy_text` to avoid reading the source code for
some things.

## Solution

- Add some additional docs.

## Changelog

- `TextSettings.max_font_atlases` in `bevy_text` has been renamed to `
TextSettings.soft_max_font_atlases`.

## Migration Guide

- Usages of `TextSettings.max_font_atlases` from `bevy_text` must be
changed to `TextSettings.soft_max_font_atlases`.
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# Objective

- Have more docs for `bevy_text` to avoid reading the source code for
some things.

## Solution

- Add some additional docs.

## Changelog

- `TextSettings.max_font_atlases` in `bevy_text` has been renamed to `
TextSettings.soft_max_font_atlases`.

## Migration Guide

- Usages of `TextSettings.max_font_atlases` from `bevy_text` must be
changed to `TextSettings.soft_max_font_atlases`.
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 M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide 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.

5 participants