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

Fix warnings reported by CI doc-build action #222

Closed
brycx opened this issue Oct 11, 2021 · 0 comments · Fixed by #239
Closed

Fix warnings reported by CI doc-build action #222

brycx opened this issue Oct 11, 2021 · 0 comments · Fixed by #239
Labels
documentation Issues and improvements sorrounding the documentation
Milestone

Comments

@brycx
Copy link
Member

brycx commented Oct 11, 2021

fiat-crypto uses "z[0]" etc to describe its operations in comment. These are intra-docs for Rust, but aren't used as such by fiat-crypto. We should extend the #[allow] for the fiat-crypto module to:

#[allow(
    dead_code,
    non_camel_case_types,
    clippy::unnecessary_cast,
    clippy::unused_unit,
    rustdoc::broken_intra_doc_links,
)]

and surround the two links in the module-level docs for fiat_curve25519_u64 with <link here>, to make the URLs clickable links.

@brycx brycx added the documentation Issues and improvements sorrounding the documentation label Oct 11, 2021
@brycx brycx added this to the v0.16.1 milestone Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and improvements sorrounding the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant