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.

Sign up for GitHub

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

Jump to bottom

Clean up documentation #119

Open
khionu opened this issue Dec 5, 2019 · 0 comments
Open

Clean up documentation #119

khionu opened this issue Dec 5, 2019 · 0 comments
Labels
good starting issue Issue is simple enough to be approachable by developers new to the code.

Comments

@khionu
Copy link
Contributor

khionu commented Dec 5, 2019

There are the following issues with the documentation:

  • TODOs and FIXMEs being rendered with the rustdocs.
  • Missing opportunities for linking to other parts of the documentation.
  • Consistencies in naming, casing, etc.

These should be addressed sooner than later, but should have a hard deadline of 0.3.0
@khionu khionu added the good starting issue Issue is simple enough to be approachable by developers new to the code. label Dec 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good starting issue Issue is simple enough to be approachable by developers new to the code.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@khionu