Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill the emptiness of generated doc #14

Open
4 tasks
weihanglo opened this issue Sep 30, 2018 · 0 comments
Open
4 tasks

Fill the emptiness of generated doc #14

weihanglo opened this issue Sep 30, 2018 · 0 comments

Comments

@weihanglo
Copy link
Owner

weihanglo commented Sep 30, 2018

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

  • crate itself
  • searching module
  • collections module
  • sorting module
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant