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

Improve ChildBuilder documentation to ensure a consistent style #7230

Closed
alice-i-cecile opened this issue Jan 16, 2023 · 0 comments · Fixed by #8371
Closed

Improve ChildBuilder documentation to ensure a consistent style #7230

alice-i-cecile opened this issue Jan 16, 2023 · 0 comments · Fixed by #8371
Labels
A-Hierarchy Parent-child entity hierarchies C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

The documentation added in #6035 is not great (see the suggestions at the bottom of the thread), but I decided to merge this relatively optimistically to help unblock an old PR.

We should clean up that documentation, and do a pass on all of the methods in that trait for consistency and clarity.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Hierarchy Parent-child entity hierarchies labels Jan 16, 2023
@JohnTheCoolingFan JohnTheCoolingFan mentioned this issue Apr 13, 2023
Merged
Estus-Dev pushed a commit to Estus-Dev/bevy that referenced this issue Jul 10, 2023
@JohnTheCoolingFan @alice-i-cecile @nicopap
ChildBuilder docs improvement (bevyengine#8371)
990ef4a 
# Objective

Fixes bevyengine#7230 

## Solution

Documented some side-effects

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Hierarchy Parent-child entity hierarchies C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ChildBuilder docs improvement JohnTheCoolingFan/bevy
1 participant
@alice-i-cecile