-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Open
Labels
A-ECSEntities, components, systems, and eventsEntities, components, systems, and eventsC-DocsAn addition or correction to our documentationAn addition or correction to our documentation
Description
How can Bevy's documentation be improved?
There are a lot of types in bevy_ecs that has the 'w and 's lifetimes:
EventReaderEventWriterQueryIterQueryManyIterQueryCombinationIterSystemParamItemParamSetCommandsEntityCommands- and more...
The best explanation found for these lifetimes are in SystemParam
Solutions I could think of right now:
- Rename
'wand'sto'worldand'state. This is not ideal since this will make the code more verbose. - Link users to the
SystemParamdocumentation. There are a lot of types to document and imo would add more noise to their documentation. - Put the documentation in the README, perhaps under a new "Advanced topics" sections.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
A-ECSEntities, components, systems, and eventsEntities, components, systems, and eventsC-DocsAn addition or correction to our documentationAn addition or correction to our documentation