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

Polish the rustdoc #6

Open
germangb opened this issue May 27, 2019 · 0 comments
Open

Polish the rustdoc #6

germangb opened this issue May 27, 2019 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@germangb
Copy link
Owner

germangb commented May 27, 2019

The documentation page is in need of a lot of polish. I'm trying to improve it incrementally with every new commit, but the constant context switching between writing features/refactoring and writing docs leaves a lot to desire...

On top of that, I'm not a native speaker (english) which I think it shows in the sometimes poor use of grammar and lack of lexicon.

Some of the things I think need to be done:

  • Fix the rushed-looking parts.
  • Some of the examples are marked as no_run or ignore (lacking set up code).
  • Some of the pages have too much information, instead of simple, concise example...
@germangb germangb added help wanted Extra attention is needed enhancement New feature or request labels May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant