weihanglo / rust-algorithm-club

Learn algorithms and data structures with Rust
https://weihanglo.tw/rust-algorithm-club
MIT License
407 stars 43 forks source link

Fill the emptiness of generated doc #14

Open weihanglo opened 6 years ago

weihanglo commented 6 years ago

The generated Rust doc is public now. Yet it seems too dumb and lack some descriptions. The crate and each modules need to be documented.

For crate doc itself, suppose we can reuse the English version of the root README.md file. Concerning module level docs, the Chinese articles are also absent. We should write down both English and Chinese intros for these three modules.

Any thought Rustaceans?

Missing Docs