rust-lang / rust-lang/rustc-dev-guide

Document how lints are actually emitted

Open
#1,168 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lints C-enhancement E-hard E-needs-investigation T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

The section on linting describes how to declare a lint and how lint passes are constructed, but we are still missing an explanation on how the lint system takes buffered lints and decides whether to actually emit them to users. For instance, how does --cap-lints work?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing linting section and trace how buffered lints are selected for emission, including the behavior of --cap-lints. Document the emission decision process and explain how the cap affects what users see; done means the guide covers this path clearly alongside lint declaration and lint-pass construction.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.