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

Maybe rename TextUiWriter to UiTextWriter #16394

Open
Olle-Lukowski opened this issue Nov 15, 2024 · 3 comments
Open

Maybe rename TextUiWriter to UiTextWriter #16394

Olle-Lukowski opened this issue Nov 15, 2024 · 3 comments
Labels
A-UI Graphical user interfaces, styles, layouts, and widgets D-Trivial Nice and easy! A great choice to get started with Bevy S-Wontfix This issue is the result of a deliberate design decision, and will not be fixed

Comments

@Olle-Lukowski
Copy link
Contributor

In bevyengine/bevy-website#1782, it was mentioned that the (WIP) migration guide for the text rework (#15591), refers to
UiTextWriter instead of the actual name we have right now TextUiWriter.

I think it is obvious how this mistake slipped in there, UiTextWriter is a more intuitive name. It is (in my opinion) better to have a type alias' name have something appended or prepended to the name, instead of plopping something in the middle (like we have right now, where we added Ui in between instead of at the front).

The same thing goes for TextUiReader, I think they should both be renamed.

Let me know what you think, just wanted to ask this before I start writing some stuff for the website.

@Olle-Lukowski Olle-Lukowski added A-UI Graphical user interfaces, styles, layouts, and widgets D-Trivial Nice and easy! A great choice to get started with Bevy labels Nov 15, 2024
@rparrett
Copy link
Contributor

These were renamed on purpose in #15887. Its migration is meant to guide section is meant to replace the one for #15591.

@BenjaminBrienen BenjaminBrienen added the S-Wontfix This issue is the result of a deliberate design decision, and will not be fixed label Nov 15, 2024
@ickshonpe
Copy link
Contributor

Yeah I didn't like the new Text<X>Reader/Writer naming scheme from the PR but didn't feel like it was important enough to fuss over.
Definitely strongly prefer prefixes or suffixes over infixes for name discriminators.

@UkoeHB
Copy link
Contributor

UkoeHB commented Nov 23, 2024

Yep also not a fan of the change, but an executive decision was made. Just forgot to update the migration guide amidst the hustle to get that PR out.

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 D-Trivial Nice and easy! A great choice to get started with Bevy S-Wontfix This issue is the result of a deliberate design decision, and will not be fixed
Projects
None yet
Development

No branches or pull requests

5 participants