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.

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

Make change detection clamping docs more accessible #5822

Open
Nilirad opened this issue Aug 28, 2022 · 0 comments
Open

Make change detection clamping docs more accessible #5822

Nilirad opened this issue Aug 28, 2022 · 0 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation

Comments

@Nilirad
Copy link
Contributor

Nilirad commented Aug 28, 2022

How can Bevy's documentation be improved?

For how change detection is currently implemented, there is a far-fetched technical limitation to it. This is already documented in the public constants CHECK_TICK_TRESHOLD and MAX_CHANGE_AGE, located in bevy_ecs::change_detection, but there are some issues with it:

  • Those constants are quite hidden, and they only seem public for the doc comments
  • The doc comments refer to check_tick, which is a private function, therefore confusing for users who don't know about the implementation details.

Proposed solution

The constants should be made private, and their documentation should be moved to the bevy_ecs::change_detection module level. They should also be adapted to be understandable to people who don't know the implementation details of change detection.

Since the module is practically undocumented, having a brief intro of what change detection is in Bevy, and how it can be used (i.e. by using the change detection filters), would be very appreciated, but not strictly necessary.


See also

@Nilirad Nilirad added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Aug 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation
Projects
None yet
Development

No branches or pull requests

1 participant