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 bevy::gizmos #8179

Closed
jakobhellermann opened this issue Mar 23, 2023 · 0 comments · Fixed by #8186
Closed

Document bevy::gizmos #8179

jakobhellermann opened this issue Mar 23, 2023 · 0 comments · Fixed by #8186
Labels
A-Gizmos Visual editor and debug gizmos A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation

Comments

@jakobhellermann
Copy link
Contributor

How can Bevy's documentation be improved?

The gizmo module was added in #6529 but it is not documented right now: https://dev-docs.bevyengine.org/bevy/gizmos/gizmos/index.html
image

We should document

  1. which type is the system param you want to use?
  2. have a module-level example for usage
  3. have per-method usage examples that are easy to copy paste. Especially for the methods returning a SphereBuilder or CircleBuilder it's not clear to be how they are intended to be used, just from the docs.
@jakobhellermann jakobhellermann added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen labels Mar 23, 2023
@cart cart added the A-Gizmos Visual editor and debug gizmos label Mar 23, 2023
@tim-blackbird tim-blackbird mentioned this issue Mar 23, 2023
Merged
@mockersf mockersf closed this as not planned Won't fix, can't repro, duplicate, stale Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Gizmos Visual editor and debug gizmos A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document bevy_gizmos tim-blackbird/bevy
3 participants
@cart @mockersf @jakobhellermann