juspay / omnix

🚧 A Nix wrapper to improve developer experience
https://omnix.page
GNU Affero General Public License v3.0
70 stars 5 forks source link

Start requiring Rust docs #221

Closed srid closed 4 weeks ago

srid commented 4 weeks ago

Let's require docs for all public modules, functions and types.

This is to help keep the code simple.

If your code needs a novel to explain, it's not simple. A few well-placed comments or doc strings can turn cryptic code into a clear narrative.