Improve documentation and add more inline doc examples.

Renmusxd / RustQIP

Quantum computing using rust. Efficient and a borrow-checked no cloning theorem!

https://docs.rs/qip/

MIT License

234 stars 18 forks source link

Improve documentation and add more inline doc examples. #10

Open Renmusxd opened 4 years ago

Renmusxd commented 4 years ago

All public structs and functions have docs, but docs can always be improved and examples are worth a thousand words. A comprehensive review to clean up documentation and provide detailed examples makes everyone's life easier.