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

[Merged by Bors] - document more of bevy_reflect #3655

Closed
wants to merge 11 commits into from
Closed

[Merged by Bors] - document more of bevy_reflect #3655

wants to merge 11 commits into from

Commits on Jan 13, 2022

  1. doc: document more of bevy_reflect 

    This adds documentation for:
- The trait methods of Reflect and its subtraits
- The partial_eq and apply functions for Map et al.
- DynamicList and DynamicMap
- TypeRegistry and related types & traits
- GetPath, including an explanation of path string syntax
    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    d0d02ce View commit details
    Browse the repository at this point in the history

  2. fix: reflect_trait markdown link

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    b879057 View commit details
    Browse the repository at this point in the history

  3. doc: Dynamic*::{name/set_name} refers to the type name

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    ca1e721 View commit details
    Browse the repository at this point in the history

  4. doc: clarify Map docs and document methods

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    83fb5c2 View commit details
    Browse the repository at this point in the history

  5. doc: write out 'if and only if'

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    a39ad87 View commit details
    Browse the repository at this point in the history

  6. doc: integrate PR feedback 

    - Document Reflect::{apply, set}
- Mention complex types' use of clone_dynamic() for clone_value()
- Correct "automatically derived" for FromReflect and mention trait
  bounds on complex types
- Mention role of get_type_data() in trait reflection
- Correct description of additional data stored by TypeRegistration
    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    cd2f792 View commit details
    Browse the repository at this point in the history

  7. doc: tie path_mut to get_path_mut, not get_path

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    f3bf97f View commit details
    Browse the repository at this point in the history

  8. doc: clarify API contract of Reflect::apply

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    55baf34 View commit details
    Browse the repository at this point in the history

  9. doc: indicate unspecified ordering of Map

    @dataphract
    dataphract committed Jan 13, 2022
    Configuration menu
    Copy the full SHA
    c9d81d9 View commit details
    Browse the repository at this point in the history

Commits on Jan 14, 2022

  1. doc: correct List apply semantics

    @dataphract
    dataphract committed Jan 14, 2022
    Configuration menu
    Copy the full SHA
    bbb2c8c View commit details
    Browse the repository at this point in the history

  2. doc: fix broken link to list_apply

    @dataphract
    dataphract committed Jan 14, 2022
    Configuration menu
    Copy the full SHA
    b1b3f9d View commit details
    Browse the repository at this point in the history