google/comprehensive-rust

Don't silence warnings in exercises

Open

#71 opened on Dec 27, 2022

View on GitHub
 (4 comments) (3 reactions) (0 assignees)Rust (2,009 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (Avg merge 9d 23h) (36 merged PRs in 30d)

Description

All the exercises start with something like

// TODO: remove this when you're done with your implementation.
#![allow(unused_variables, dead_code)]

You're training people that it's normal and a good idea to ignore warnings during development. Instead, continue to emphasize what you mention in passing elsewhere -- Rust has great compiler errors!

Of course it's going to have a lot of warnings at the start since you've given them incomplete code. You can

  • Just let them deal with it
  • Or mention RUSTFLAGS=-A... cargo ... perhaps

But you shouldn't imply ignoring warnings until you're "done with your implementation" is a good idea, or IMO that ignoring warnings in your source code (as opposed to a command line flag) is a good idea.

Contributor guide

Research direction
Find all exercises with `#![allow(unused variables, dead code)]` lines and remove them. Ensure the exercises still compile without warnings by adding `#[allow(...)]` only where needed or by restructuring code.
Tech stack
rust
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80