rust-lang / rust-lang/rust-clippy
Suggest changing *x to x in toplevel_ref_arg
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
If we have a toplevel ref argument, toplevel_ref_arg will suggest removing the ref (it should perhaps also propose removing mut if it's there). However, this will lead to error if the argument is dereferenced within the function.
At the very least, the message should note that dereferences can lead to errors. Better yet would be to find all those instances and suggest removing the *.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the toplevel_ref_arg lint and read how it constructs its suggestion. Check how dereferences and mut are handled within the function, then inspect any existing tests for this lint. Done means the suggestion no longer produces an invalid change, either by accounting for dereferences or by clearly warning about them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100