google/comprehensive-rust

Run clippy on code examples

Open

#508 opened on Mar 15, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (32,954 stars) (2,009 forks)batch import
help wanted

Description

Running it on the code in Cargo workspaces should be straightforward. It is unclear how to do so on inline code samples.

Contributor guide

Tech stack
rust
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Rust basicsClippy toolCargo workspaces
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine existing CI configuration or scripts in the repository to see how clippy is currently used (e.g., in GitHub Actions). Determine how to run clippy on all code examples, especially inline code samples within markdown. Investigate tools like `mdbook` or custom parsing to extract Rust code from documentation. Check if any similar issues or PRs provide hints.
Run clippy on code examples · google/comprehensive-rust#508 | Good First Issue