Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I'm sure you know because you're Steve Klabnik, but for other readers: you can enforce documentation for public items in a crate by adding `#![deny(missing_docs)]` to the `lib.rs` file.

Then it just takes some self-control and gold code reviews to make sure you're writing good documentation rather than just short stubs to silence the error.



You’d think, but I have certainly committed (in both the colloquial and git sense) a dummy /// TODO comment to silence this warning... oops




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: