TheBevyFlock / bevy_cli

A Bevy CLI tool and linter.
https://thebevyflock.github.io/bevy_cli/
Apache License 2.0
52 stars 7 forks source link

Document category of lint in documentation #112

Closed BD103 closed 1 month ago

BD103 commented 2 months ago

It is not currently possible to see what category a lint is in in the rustdoc output without inspecting the source code. This isn't user-friendly, and makes it difficult to find examples of why you would want certain categories.

The biggest question is how this should be communicated. I've mocked out a few ideas, though I'm not particularly happy with any of them:

image