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

Add a lint list, to display the documentation for installed lints #89

Open
xFrednet opened this issue Jan 11, 2023 · 0 comments
Open

Add a lint list, to display the documentation for installed lints #89

xFrednet opened this issue Jan 11, 2023 · 0 comments
Labels
A-marker-cargo Area: All things connected to `cargo_marker` C-enhancement Category: New feature or request

Comments

@xFrednet
Copy link
Member

Lints often have more context and reasoning than what's included in the emitted diagnostic message. Rustc and Clippy both provide an external list of the lints with a detailed explanation and suggestions how to fix the problem:

  1. https://rust-lang.github.io/rust-clippy/master/index.html
  2. https://doc.rust-lang.org/rustc/lints/listing/warn-by-default.html

Marker should also provide an option to display which lints are installed, along with the documentation provided by them in the declare_lint! macro. This could be in the form of a cargo marker doc comment, that fetches the description from the lint crates and then combines them into a website. Ideally searchable, and more than just plain HTML.

@xFrednet xFrednet added C-enhancement Category: New feature or request A-marker-cargo Area: All things connected to `cargo_marker` labels Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-marker-cargo Area: All things connected to `cargo_marker` C-enhancement Category: New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant