Skip to content

[Merged by Bors] - Add docstring comment to Style to reference CSS#2936

Closed
djeedai wants to merge 4 commits intobevyengine:mainfrom
djeedai:ui_css
Closed

[Merged by Bors] - Add docstring comment to Style to reference CSS#2936
djeedai wants to merge 4 commits intobevyengine:mainfrom
djeedai:ui_css

Conversation

@djeedai
Copy link
Contributor

@djeedai djeedai commented Oct 8, 2021

Mention the fact that the UI layout system is based on the CSS layout
model through a docstring comment on the Style type.

Objective

Explain to new users that the Bevy UI uses the CSS layout model, to lower the barrier to entry given the fact documentation (book and code) is fairly limited on the topic.

Solution

Fix as discussed with @alice-i-cecile on #2918.

Mention the fact that the UI layout system is based on the CSS layout
model through a docstring comment on the `Style` type.
@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Oct 8, 2021
@NiklasEi NiklasEi added A-UI Graphical user interfaces, styles, layouts, and widgets C-Docs An addition or correction to our documentation S-Needs-Review and removed S-Needs-Triage This issue needs to be labelled labels Oct 8, 2021
@alice-i-cecile
Copy link
Member

Added an additional more user-friendly link to help folks navigate things :) Other than that, LGTM, thanks!

djeedai and others added 2 commits October 8, 2021 22:00
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
@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 9, 2021
Copy link
Member

@mockersf mockersf left a comment

Choose a reason for hiding this comment

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

there is one difference with Flexbox that should be mentioned: Bevy is upside down, with the vertical axis inverted

@djeedai
Copy link
Contributor Author

djeedai commented Nov 6, 2021

Who's doing the final review? Is that only @cart? If so, ping, this is very short to review and ready for merge, thanks! 🙏

@alice-i-cecile
Copy link
Member

Generally only Cart. @mockersf has merge writes for "uncontroversial" PRs however, which I think this qualifies for.

@cart
Copy link
Member

cart commented Nov 6, 2021

Yup this is uncontroversial. But I'll merge it because I'm here :)

@cart
Copy link
Member

cart commented Nov 6, 2021

bors r+

bors bot pushed a commit that referenced this pull request Nov 6, 2021
Mention the fact that the UI layout system is based on the CSS layout
model through a docstring comment on the `Style` type.

# Objective

Explain to new users that the Bevy UI uses the CSS layout model, to lower the barrier to entry given the fact documentation (book and code) is fairly limited on the topic.

## Solution

Fix as discussed with @alice-i-cecile on #2918.
@bors bors bot changed the title Add docstring comment to Style to reference CSS [Merged by Bors] - Add docstring comment to Style to reference CSS Nov 6, 2021
@bors bors bot closed this Nov 6, 2021
@djeedai djeedai deleted the ui_css branch November 6, 2021 21:24
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 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