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

Fill in rustdoc documentation #56

Open

jpmckinney opened this issue May 24, 2023 · 0 comments

Labels

Milestone

Member

jpmckinney commented May 24, 2023 •

edited

Loading

Right now, most of this is stubbed (e.g. # Errors, # Panics) to satisfy cargo clippy.

That said, Cardinal is expected to be used as a CLI. not as a Rust library, so scheduling as nice-to-have.

Update CI e.g. https://github.com/rust-lang/log/blob/7e2dde2c0f195eb998449e411bf48ca5dfa1fdfe/.github/workflows/main.yml#L86 See also https://docs.rs/docmatic/latest/docmatic/ or https://docs.rs/doc-comment/latest/doc_comment/

The text was updated successfully, but these errors were encountered:

jpmckinney added the documentation label

jpmckinney added this to the Nice-to-have milestone

This was referenced May 27, 2023

Test for warnings in rustdoc documentation #51

Closed

Contributor documentation #29

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment