rust-lang / rust-lang/rust-clippy

Consider deleting `FORMAT_MACRO_DIAG_ITEMS`, and tag the macros in stdlib

Open
#14,267 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Now that #[clippy::format_args] has been released, should we delete the FORMAT_MACRO_DIAG_ITEMS list, and instead tag all relevant macros with the new attribute in the stdlib?

Benefits
  • Keep each macro's metadata next to the declaration.
  • No need to track when new relevant macros are written
  • Improves discoverability of the #[clippy::format_args], as any developer writing format-like macro will see it in the declaration
Blockers

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 with clippy_utils/src/macros.rs and review the linked Rust issue 98291, which is listed as the blocker. Identify the relevant stdlib macros and determine whether the existing FORMAT_MACRO_DIAG_ITEMS list can be removed in favor of the released attribute. Done means the metadata is attached to the relevant macro declarations and the old list is deleted.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Refactor
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.