Skip to content

Conversation

@LinusKall
Copy link
Contributor

Objective

Fixes #6866.

Solution

Docs now should describe what the front, first, back, and last elements are for an implementor of the bevy::reflect::list::List Trait. Further, the docs should describe how bevy::reflect::list::List::push and bevy::reflect::list::List::pop should act on these elements.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Reflection Runtime information about types labels Dec 6, 2022
@alice-i-cecile alice-i-cecile requested a review from MrGVSV December 6, 2022 18:04
Copy link
Member

@MrGVSV MrGVSV left a comment

Choose a reason for hiding this comment

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

Nice! Just one comment.

@LinusKall LinusKall marked this pull request as ready for review December 6, 2022 19:37
@james7132 james7132 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 Dec 7, 2022
@mockersf
Copy link
Member

mockersf commented Dec 7, 2022

bors r+

bors bot pushed a commit that referenced this pull request Dec 7, 2022
# Objective

Fixes #6866.

## Solution

Docs now should describe what the _front_, _first_, _back_, and _last_ elements are for an implementor of the `bevy::reflect::list::List` Trait. Further, the docs should describe how `bevy::reflect::list::List::push` and `bevy::reflect::list::List::pop` should act on these elements.


Co-authored-by: Linus Käll <[email protected]>
@james7132 james7132 added this to the 0.10 milestone Dec 7, 2022
@bors bors bot changed the title Updated docs for List Trait in bevy_reflect [Merged by Bors] - Updated docs for List Trait in bevy_reflect Dec 7, 2022
@bors bors bot closed this Dec 7, 2022
@LinusKall LinusKall deleted the reflect_list_trait_docs branch December 8, 2022 09:03
alradish pushed a commit to alradish/bevy that referenced this pull request Jan 22, 2023
# Objective

Fixes bevyengine#6866.

## Solution

Docs now should describe what the _front_, _first_, _back_, and _last_ elements are for an implementor of the `bevy::reflect::list::List` Trait. Further, the docs should describe how `bevy::reflect::list::List::push` and `bevy::reflect::list::List::pop` should act on these elements.


Co-authored-by: Linus Käll <[email protected]>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Fixes bevyengine#6866.

## Solution

Docs now should describe what the _front_, _first_, _back_, and _last_ elements are for an implementor of the `bevy::reflect::list::List` Trait. Further, the docs should describe how `bevy::reflect::list::List::push` and `bevy::reflect::list::List::pop` should act on these elements.


Co-authored-by: Linus Käll <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Reflection Runtime information about types 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.

bevy_reflect: Improve List::push and List::pop docs

5 participants