rust-lang / rust-lang/rust-clippy

Lint suggestion: benchmarks in main crate code

Open
#397 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Benchmarks in main crate code mean that the whole code has to opt into test.

Also, in any cargo project, benchmark files can be put into the benches folder, which is a much more appropriate place.

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 locating the benchmark code currently embedded in the main crate and compare it with Cargo's conventional benches directory mentioned in the issue. Done means benchmarks are separated from the main crate code so the crate no longer needs to opt into test, while the benchmarks remain available.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 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.