-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Open
Labels
A-Cross-CuttingImpacts the entire engineImpacts the entire engineC-DocsAn addition or correction to our documentationAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with BevyNice and easy! A great choice to get started with BevyS-Ready-For-ImplementationThis issue is ready for an implementation PR. Go for it!This issue is ready for an implementation PR. Go for it!
Description
How can Bevy's documentation be improved?
For derivable traits such as WorldQuery, SystemParam, Bundle, etc., documentation for the derive macro is placed on the trait definition itself, rather than the derive macro. This means that when hovering over a #[derive(WorldQuery)] attribute, it appears to be mostly undocumented.
Any documentation regarding the derive macro should be moved to the derive macro -- this information is not relevant to consumers of the trait, and is not discoverable for those trying to derive it.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
A-Cross-CuttingImpacts the entire engineImpacts the entire engineC-DocsAn addition or correction to our documentationAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with BevyNice and easy! A great choice to get started with BevyS-Ready-For-ImplementationThis issue is ready for an implementation PR. Go for it!This issue is ready for an implementation PR. Go for it!