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 useful documentation #2

Open
Follpvosten opened this issue Jan 17, 2020 · 0 comments
Open

Write useful documentation #2

Follpvosten opened this issue Jan 17, 2020 · 0 comments

Comments

@Follpvosten
Copy link
Contributor

The documentation of this crate is currently rather poor; the only doc comments are in the mdc_sys module, and they are copied directly from the MDC docs.

Ideally, there would be crate-level docs that produce the README (#1) using cargo-readme, as well as module-level docs per component with more detailed usage examples.

Publishing docs will be a separate issue (which will get relevant once I'm at a version 0.1.0)

@Follpvosten Follpvosten mentioned this issue Mar 23, 2020
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant