bevyengine / bevyengine/bevy

AsBindGroup derive macro should link to the AsBindGroup trait documentation

Open
#16,955 2 comments 0 reactions 0 assignees View on GitHub
A-Rendering C-Docs D-Trivial S-Ready-For-Implementation
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

The derive macro documentation is [here](https://docs.rs/bevy/latest/bevy/render/render_resource/derive.AsBindGroup.html).
Currently, the derive attributes (`#[uniform]`, `#[texture_storage]`, etc) are well documented in the [trait](https://docs.rs/bevy/latest/bevy/render/render_resource/trait.AsBindGroup.html) 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).

Contributor guide

Open the contributing guide

Research direction

Start with the AsBindGroup derive macro documentation and the linked AsBindGroup trait documentation described in the issue, then locate the source for the macro's docs. Add a sentence linking readers to the trait documentation for detailed derive-attribute information; done means the macro docs contain that link and the documentation still builds correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.