rust-lang / rust-lang/rust-clippy

Lint ambiguous function names

Open
#7,393 0 comments 0 reactions 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

Lints highly ambiguous function names. The ones that come to mind are

  • my_function
  • function
  • a_function
Categories (optional)
  • Kind: style
Drawbacks

None.

Example
fn my_function() {
  // if you use this you make everyone's life 😭 
}

Could be written as:

fn useful_function_name() {
}

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

Start by reviewing rust-clippy's existing lint implementations and test conventions for style checks. Establish which names qualify as highly ambiguous, using the examples in the issue as initial cases, and define tests that show the lint flags them without rejecting useful names. Done means the lint consistently reports the targeted ambiguous function names.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.