google / comprehensive-rust

This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
https://google.github.io/comprehensive-rust/
Apache License 2.0
27.96k stars 1.67k forks source link

Add missing docstring to birthday server implementation #2464

Open mgeisler opened 3 days ago

mgeisler commented 3 days ago

Without this, compilation fails. The comment is in the included Rust file — but we only include a fraction of the file to keep the example short. This makes it cumbersome to both show something that works in the slides while also making it possible for the instructor to show more complex examples.

@randomPoison, we need to make our examples simpler here: the complexity here makes it hard to modify the files and I feel it's hard to show during class. I would suggest splitting this up into a very basic example (what the birthday service was) and then add 1-2 slides with more complex samples (if necessary). Last I taught the class, I had a hard time a) making every example compile and b) finding time to cover everything.

I would err on the side of makings things simple and clear.