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.

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

[Merged by Bors] - Use Explicit Names for Flex Direction #2672

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Use Explicit Names for Flex Direction #2672

wants to merge 1 commit into from

Conversation

mirkoRainer
Copy link
Contributor

Objective

  • Clarify vague meaning of "Ltr" and "Rtl". For someone familiar with Flex Box, this is easy to understand, but being more explicit will help beginners or those unfamiliar, without the need to do research.

Solution

  • Change three letter abbreviation to fully descriptive name.

@mirkoRainer
Using explicit names for this abbreviation will help beginners unders…
c99ad99 
…tand what it means without having to decipher it first.
@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Aug 17, 2021
@alice-i-cecile
Copy link
Member

I agree; this is a nice simple improvement.

@alice-i-cecile alice-i-cecile added A-UI Graphical user interfaces, styles, layouts, and widgets C-Usability A targeted quality-of-life change that makes Bevy easier to use 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-Triage This issue needs to be labelled labels Aug 17, 2021
@mockersf
Copy link
Member

I think that until we have a new UI system that doesn't rely as much on Flexbox, we're best sticking to the same terminology (css/flexbox) so that it's easier to google. There's even a featured snippet if you search directly "direction ltr".

Docstrings would be good though

@mirkoRainer
Copy link
Contributor Author

I think that until we have a new UI system that doesn't rely as much on Flexbox, we're best sticking to the same terminology (css/flexbox) so that it's easier to google. There's even a featured snippet if you search directly "direction ltr".

Docstrings would be good though

The fact that this is searched so much only reinforces my point. You shouldn't have to search for "direction ltr" to understand what this does. Docstrings are definitely good and I'll plan on adding them for this section.

I would argue two points:

  1. Just because other frameworks use this vague variable name doesn't mean bevy has to continue the obscurity.
  2. If the term were more colloquial, I would be in favor of keeping it. (i.e. people don't say Hypertext Transfer Protocol in conversation, it's referred to as HTTP.) I'm not certain LTR/RTL is contextual enough outside of UI/UX/CSS context vice general software/computer science context.

@stshine
Copy link

stshine commented Aug 19, 2021

IMO "Start" and "End" are better names.

@mirkoRainer
Copy link
Contributor Author

IMO "Start" and "End" are better names.

Start and End are relative. Certain languages "Start" on the right, whilst others Start in the left.
i.e. Arabic vs English

NiklasEi
NiklasEi approved these changes Aug 20, 2021
View reviewed changes
Copy link
Member

@NiklasEi NiklasEi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks much nicer to me 👍

@cart
Copy link
Member

cart commented Aug 24, 2021

I'm sold on this. If it was anything more complicated than a rename I'd probably push back due to the impending ui refresh, but this is an easy clarity win. And being 100% aligned with web spec names isn't really a priority for me (relative to clarity).

@cart
Copy link
Member

cart commented Aug 24, 2021

bors r+

bors bot pushed a commit that referenced this pull request Aug 24, 2021
@mirkoRainer
Use Explicit Names for Flex Direction (#2672)
958f8b1 
# Objective

- Clarify vague meaning of "Ltr" and "Rtl". For someone familiar with Flex Box, this is easy to understand, but being more explicit will help beginners or those unfamiliar, without the need to do research.

## Solution

- Change three letter abbreviation to fully descriptive name.
@bors
Copy link
Contributor

bors bot commented Aug 24, 2021

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Use Explicit Names for Flex Direction [Merged by Bors] - Use Explicit Names for Flex Direction Aug 24, 2021
@bors bors bot closed this Aug 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NiklasEi NiklasEi NiklasEi approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-UI Graphical user interfaces, styles, layouts, and widgets C-Usability A targeted quality-of-life change that makes Bevy easier to use 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@mirkoRainer @alice-i-cecile @mockersf @stshine @cart @NiklasEi