Skip to content

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

@MrGVSV

Description

@MrGVSV

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:

  1. "pushing" always appends the element to the end of the list
  2. "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

No one assigned

    Labels

    A-ReflectionRuntime information about typesC-DocsAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with Bevy

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions