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

Document every public item in bevy_ecs #8731

Merged
merged 65 commits into from
Jun 10, 2023
Merged

Document every public item in bevy_ecs #8731

merged 65 commits into from
Jun 10, 2023

Commits on May 31, 2023

  1. add docs to Access structs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    cba8a45 View commit details
    Browse the repository at this point in the history

  2. add docs to ParIter

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    eb3e2e7 View commit details
    Browse the repository at this point in the history

  3. add docs to QueryState methods

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    28ba325 View commit details
    Browse the repository at this point in the history

  4. add missing docs to condition.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    b532943 View commit details
    Browse the repository at this point in the history

  5. add missing docs to SystemConfig/s

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    0f647af View commit details
    Browse the repository at this point in the history

  6. add missing docs to NodeId variants

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    210bbb0 View commit details
    Browse the repository at this point in the history

  7. add missing docs to new functions for schedules

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    e82f1ef View commit details
    Browse the repository at this point in the history

  8. add docs to States::Iter

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    efb8eb9 View commit details
    Browse the repository at this point in the history

  9. add missing docs for system sets

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    34eeb15 View commit details
    Browse the repository at this point in the history

  10. add docs to SparseSetIndex

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    3978b66 View commit details
    Browse the repository at this point in the history

  11. add docs to CombinatorSystem

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    4c3f980 View commit details
    Browse the repository at this point in the history

  12. add docs to ParallelCommands::command_scope

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    8f1481f View commit details
    Browse the repository at this point in the history

  13. add docs to system marker types

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    85ee513 View commit details
    Browse the repository at this point in the history

  14. add docs to System::apply_buffers

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    6ab8119 View commit details
    Browse the repository at this point in the history

  15. add docs to IntoSystem::system

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    bb8d299 View commit details
    Browse the repository at this point in the history

  16. add docs to SystemName

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    a9cd743 View commit details
    Browse the repository at this point in the history

  17. add docs to SystemState

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    0895efd View commit details
    Browse the repository at this point in the history

  18. add missing docs to Archetype

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    aa194f6 View commit details
    Browse the repository at this point in the history

  19. add missing docs to bundle.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    3875e1a View commit details
    Browse the repository at this point in the history

  20. add missing docs to change detection methods

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    da6683d View commit details
    Browse the repository at this point in the history

  21. Merge remote-tracking branch 'upstream/main' into ecs-docs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    7421b1e View commit details
    Browse the repository at this point in the history

  22. add missing docs to commands

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    e03a0fd View commit details
    Browse the repository at this point in the history

  23. add missing docs to system params

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    eead342 View commit details
    Browse the repository at this point in the history

  24. add docs to check_change_tick

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    e37bffd View commit details
    Browse the repository at this point in the history

  25. document SystemState::new

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    c97c067 View commit details
    Browse the repository at this point in the history

  26. document executor constructors

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    a29c867 View commit details
    Browse the repository at this point in the history

  27. add missing docs to WorldQuery

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    14ed693 View commit details
    Browse the repository at this point in the history

  28. document archetype_components_len

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    206b7f5 View commit details
    Browse the repository at this point in the history

  29. publicly document Entities::flush_as_invalid

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    5e0f339 View commit details
    Browse the repository at this point in the history

  30. add missing docs to entity_ref.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    578c3ca View commit details
    Browse the repository at this point in the history

  31. document world modules

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    3f64496 View commit details
    Browse the repository at this point in the history

  32. add missing docs to world methods

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    3a43ebb View commit details
    Browse the repository at this point in the history

  33. add missing docs to SpawnBatchIter

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    c15e992 View commit details
    Browse the repository at this point in the history

  34. add missing docs to unsafe_world_cell.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    edf776e View commit details
    Browse the repository at this point in the history

  35. add missing docs to WorldCell

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    2c2bb08 View commit details
    Browse the repository at this point in the history

  36. add missing docs to component.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    35db910 View commit details
    Browse the repository at this point in the history

  37. add missing docs to event.rs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    5ea50f2 View commit details
    Browse the repository at this point in the history

  38. document top-level modules

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    07d73ff View commit details
    Browse the repository at this point in the history

  39. add missing docs for RemovedComponents

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    2ec8f7c View commit details
    Browse the repository at this point in the history

  40. add missing docs to ReflectMapEntities

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    d511301 View commit details
    Browse the repository at this point in the history

  41. warn on missing docs

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    b34abc3 View commit details
    Browse the repository at this point in the history

  42. Fix ape-brain comments 

    Co-authored-by: François <mockersf@gmail.com>
    @JoJoJet @mockersf
    JoJoJet and mockersf committed May 31, 2023
    Configuration menu
    Copy the full SHA
    94ed960 View commit details
    Browse the repository at this point in the history

  43. remove a reference to a private function

    @JoJoJet
    JoJoJet committed May 31, 2023
    Configuration menu
    Copy the full SHA
    3fd9d3d View commit details
    Browse the repository at this point in the history

Commits on Jun 2, 2023

  1. Apply suggestions from code review 

    Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
    @JoJoJet @alice-i-cecile
    JoJoJet and alice-i-cecile committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    4364e08 View commit details
    Browse the repository at this point in the history

  2. Rewrite docs for Bundles

    @JoJoJet
    JoJoJet committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    912c737 View commit details
    Browse the repository at this point in the history

  3. Merge remote-tracking branch 'upstream/main' into ecs-docs

    @JoJoJet
    JoJoJet committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    86d747a View commit details
    Browse the repository at this point in the history

  4. Apply suggestions from code review 

    Co-authored-by: James Liu <contact@jamessliu.com>
    @JoJoJet @james7132
    JoJoJet and james7132 committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    ca47a6a View commit details
    Browse the repository at this point in the history

  5. Clarify when Bundles::get returns None

    @JoJoJet
    JoJoJet committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    cc3c824 View commit details
    Browse the repository at this point in the history

  6. Tweak docs for Ref::into_inner

    @JoJoJet
    JoJoJet committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    6ffa2c9 View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2023

  1. rewrite docs for Archetypes::generation

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    96099b8 View commit details
    Browse the repository at this point in the history

  2. apply_buffers -> apply_deferred

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    d3f847c View commit details
    Browse the repository at this point in the history

  3. qualify a type in docs

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    012c1fe View commit details
    Browse the repository at this point in the history

  4. use different syntax to qualify a doc link

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    3d0ab51 View commit details
    Browse the repository at this point in the history

  5. Fix a typo

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    c68f9dc View commit details
    Browse the repository at this point in the history

  6. Make some phrasing more general

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    31b5021 View commit details
    Browse the repository at this point in the history

  7. Tweak documentation for Components metadata functions

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    8c6ada9 View commit details
    Browse the repository at this point in the history

  8. tweak docs for validate_world

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    a23d102 View commit details
    Browse the repository at this point in the history

  9. variants

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    9faf035 View commit details
    Browse the repository at this point in the history

  10. Merge remote-tracking branch 'upstream/main' into ecs-docs

    @JoJoJet
    JoJoJet committed Jun 3, 2023
    Configuration menu
    Copy the full SHA
    8b7d4e7 View commit details
    Browse the repository at this point in the history

Commits on Jun 8, 2023

  1. Merge remote-tracking branch 'upstream/main' into ecs-docs

    @JoJoJet
    JoJoJet committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    5213b1c View commit details
    Browse the repository at this point in the history

  2. rewrite docs for QueryState::get_manual

    @JoJoJet
    JoJoJet committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    39ac5c7 View commit details
    Browse the repository at this point in the history

  3. ComponentId is not opaque

    @JoJoJet
    JoJoJet committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    5aa7b0f View commit details
    Browse the repository at this point in the history

Commits on Jun 9, 2023

  1. Option -> Result

    @JoJoJet
    JoJoJet committed Jun 9, 2023
    Configuration menu
    Copy the full SHA
    94b3a2d View commit details
    Browse the repository at this point in the history

  2. ComponentId::new

    @JoJoJet
    JoJoJet committed Jun 9, 2023
    Configuration menu
    Copy the full SHA
    e5c2284 View commit details
    Browse the repository at this point in the history

  3. doc links

    @JoJoJet
    JoJoJet committed Jun 9, 2023
    Configuration menu
    Copy the full SHA
    ebc14e9 View commit details
    Browse the repository at this point in the history