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

Write more documentation #48

Closed
ebkalderon opened this issue May 27, 2019 · 1 comment
Closed

Write more documentation #48

ebkalderon opened this issue May 27, 2019 · 1 comment

Comments

@ebkalderon
Copy link
Owner

At the time of writing, many methods lack documentation and are instead annotated with #[allow(missing_docs)]. These annotations should be replaced with actual doc comments containing explanations and inline doc tests.

Some modules, most notably the top-level lib.rs, might also benefit from an additional section in the existing docs with example code demonstrating proper usage of the API.

@ebkalderon
Copy link
Owner Author

Fixed in #81.

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