rust-lang / rust-lang/rust-clippy

Document `pub` functions in `clippy_utils`

Open
#15,569 11 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

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

Description

Description

Quite a lot of functions in clippy_utils lack documentation. Ideally, the missing_docs lint should be enabled on this crate, except for selected entities such as the static path definitions in the paths module (which might be moved into a submodule).

Note: we are not looking for LLM generated verbose documentation.

Version
Additional Labels

@rustbot label "+good first issue"

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.