Skip to content

Documentation for derive macros is in the wrong place #6195

@joseph-gio

Description

@joseph-gio

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-Cross-CuttingImpacts the entire engineC-DocsAn addition or correction to our documentationD-TrivialNice and easy! A great choice to get started with BevyS-Ready-For-ImplementationThis issue is ready for an implementation PR. Go for it!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions