search

Sensirion / sensirion-i2c-rs

Rust library with common functionality for our I2C sensors
BSD 3-Clause "New" or "Revised" License
12 stars 8 forks source link

Crate docs #9

Closed dbrgn closed 4 years ago

dbrgn commented 4 years ago

The documentation looks a bit... thin right now :slightly_smiling_face:

2020-08-24-174642_1303x538_scrot

Adding some docs (explaining how the crate is meant to be used and what the functions do) would definitely improve things!

dbrgn commented 4 years ago

(You might even want to add #![deny(missing_docs)] to the crate attributes.)

rnestler commented 4 years ago

Is there a way to avoid duplicating documentation in the README.md and lib.rs?

rnestler commented 4 years ago

Oh there is https://github.com/rust-lang/rust/issues/44732 which describes exactly this use case :slightly_smiling_face: