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

AsBindGroup derive macro should link to the AsBindGroup trait documentation #16955

Open
Lege19 opened this issue Dec 24, 2024 · 2 comments
Open
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!

Comments

@Lege19
Copy link

Lege19 commented Dec 24, 2024

The derive macro documentation is here.
Currently, the derive attributes (#[uniform], #[texture_storage], etc) are well documented in the trait documentation. From the trait perspective, this makes sense, because the vast majority of users will never manually implement this trait, however it would make more sense to put this information in the derive macro documentation and link to it in the trait documentation.
I think that's probably more effort than it's worth though, so instead I'm suggesting to just add a sentence to the macro documentation saying that there is much more detailed information available in the trait documentation (an a link to it).

@Lege19 Lege19 added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Dec 24, 2024
@BenjaminBrienen BenjaminBrienen added D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it! and removed S-Needs-Triage This issue needs to be labelled labels Dec 24, 2024
@ItsDoot
Copy link
Contributor

ItsDoot commented Dec 24, 2024

Related, possibly duplicate: #6195

@BenjaminBrienen
Copy link
Contributor

I don't think it is possible to link to an external item like that. Adding the documentation on the re-export breaks the documentation for the derive macro entirely.

@BenjaminBrienen BenjaminBrienen removed their assignment Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants