-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Closed
Labels
A-ReflectionRuntime information about typesRuntime information about typesC-DocsAn addition or correction to our documentationAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with BevyNice and easy! A great choice to get started with Bevy
Description
How can Bevy's documentation be improved?
The docs on List::push and List::pop should better explain the directionality of those operations, as explained in this comment.
We should direct manual (and internal) implementors to uphold the contract that:
- "pushing" always appends the element to the end of the list
- "popping" always removes the element from the end of the list
The docs already do this to an extent, but they could give just a bit more detail and make the guarantee more explicit so implementors don't miss it!
Metadata
Metadata
Assignees
Labels
A-ReflectionRuntime information about typesRuntime information about typesC-DocsAn addition or correction to our documentationAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with BevyNice and easy! A great choice to get started with Bevy
Type
Projects
Status
Done