rust-lang / rust-lang/rust-clippy

lint against shadowing prelude types in the signature of public functions

Open
#13,426 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

warn if any item that shares a name with an item in the prelude is used without qualification in the signature of a public function.

Advantage

people might see the auto-generated documentation and think it is referring to the prelude type instead of another type.

Drawbacks

this pattern is extremely common in the rust ecosystem, especially with Result types.

Example
use std::io::Result;

fn unclear() -> Result<()> {
    Ok(())
}

Could be written as:

use std::io;

fn unclear() -> io::Result<()> {
    Ok(())
}

Contributor guide

Open the contributing guide

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

No implementation files or tests are named. Start by locating existing Clippy lints that inspect public function signatures and their UI tests, then trace how prelude names and qualified paths are represented. Done means the lint diagnoses unqualified shadowing in public signatures, handles the documented example, and has coverage for the intended behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.