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

Tidy up UI node docs #10189

Merged
merged 8 commits into from
Oct 21, 2023
Merged

Conversation

rparrett
Copy link
Contributor

@rparrett rparrett commented Oct 19, 2023

Objective

While reviewing #10187 (404 now, GH banned the user for spam) I noticed some other mistakes in the UI node docs.

Solution

I did a quick proofreading pass and fixed a few things. And of course, the typo from that other PR.

Notes

I occasionally insert a period to make a section of doc self-consistent but didn't go one way or the other on all periods in the file.

@rparrett rparrett added C-Docs An addition or correction to our documentation A-UI Graphical user interfaces, styles, layouts, and widgets labels Oct 19, 2023
@NoahShomette NoahShomette self-requested a review October 21, 2023 01:38
Copy link
Contributor

@NoahShomette NoahShomette left a comment

Choose a reason for hiding this comment

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

Several of these are nitpicks, I don't have strong opinions on the clear nitpicks but as long as the documentation of this file is the focus might as well fix the smaller 'errors' while we are here imo. Approving just cuz most of it is small but there are some genuine errors in there are as well

crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved
@rparrett
Copy link
Contributor Author

I think I got all of your feedback incorporated. Thanks!

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 21, 2023
@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 21, 2023
Merged via the queue into bevyengine:main with commit 38e0a80 Oct 21, 2023
22 checks passed
robtfm pushed a commit to robtfm/bevy that referenced this pull request Oct 23, 2023
# Objective

While reviewing bevyengine#10187 I noticed some other mistakes in the UI node
docs.

## Solution

I did a quick proofreading pass and fixed a few things. And of course,
the typo from that other PR.

## Notes

I occasionally insert a period to make a section of doc self-consistent
but didn't go one way or the other on all periods in the file.

---------

Co-authored-by: Noah <[email protected]>
ameknite pushed a commit to ameknite/bevy that referenced this pull request Nov 6, 2023
# Objective

While reviewing bevyengine#10187 I noticed some other mistakes in the UI node
docs.

## Solution

I did a quick proofreading pass and fixed a few things. And of course,
the typo from that other PR.

## Notes

I occasionally insert a period to make a section of doc self-consistent
but didn't go one way or the other on all periods in the file.

---------

Co-authored-by: Noah <[email protected]>
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# Objective

While reviewing bevyengine#10187 I noticed some other mistakes in the UI node
docs.

## Solution

I did a quick proofreading pass and fixed a few things. And of course,
the typo from that other PR.

## Notes

I occasionally insert a period to make a section of doc self-consistent
but didn't go one way or the other on all periods in the file.

---------

Co-authored-by: Noah <[email protected]>
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.

4 participants