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

Documentation pass #344

Merged
merged 5 commits into from
Jul 2, 2024
Merged

Documentation pass #344

merged 5 commits into from
Jul 2, 2024

Conversation

jschneider-bensch
Copy link
Collaborator

@jschneider-bensch jschneider-bensch commented Jul 2, 2024

In this PR I've updated the docs of the verified code to mostly align with those of the pre-verification code.

I've also changed the visibility of the unpacked API in the verified code until we have #330.

  • Rust docs
  • Readme

@jschneider-bensch jschneider-bensch changed the base branch from main to dev July 2, 2024 07:56
@jschneider-bensch jschneider-bensch linked an issue Jul 2, 2024 that may be closed by this pull request
@jschneider-bensch jschneider-bensch marked this pull request as ready for review July 2, 2024 08:50
Copy link
Member

@franziskuskiefer franziskuskiefer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, lgtm with one nit.

libcrux-ml-kem/README.md Outdated Show resolved Hide resolved
@franziskuskiefer franziskuskiefer merged commit f1dfed0 into dev Jul 2, 2024
46 checks passed
@franziskuskiefer franziskuskiefer deleted the jonas/doc-pass branch July 2, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Update ml-kem docs
2 participants