From c7ca638f3137248e5e7233235492c9da6429fa26 Mon Sep 17 00:00:00 2001 From: Jonas Schneider-Bensch Date: Thu, 27 Jun 2024 14:23:02 +0200 Subject: [PATCH] Call out the `kyber` feature more prominently --- libcrux-ml-kem/src/lib.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/libcrux-ml-kem/src/lib.rs b/libcrux-ml-kem/src/lib.rs index 57c4cccfa..70821b718 100644 --- a/libcrux-ml-kem/src/lib.rs +++ b/libcrux-ml-kem/src/lib.rs @@ -1,7 +1,8 @@ //! # ML-KEM //! //! This crate implements all three ML-KEM variants 512, 768, and 1024. It is -//! formally verified using [hax](https://cryspen.com/hax) and [F*](https://fstar-lang.org). +//! formally verified using [hax](https://cryspen.com/hax) and +//! [F*](https://fstar-lang.org). //! //! ``` //! use rand::{rngs::OsRng, RngCore}; @@ -41,10 +42,12 @@ //! //! In addition to the verified implementations of the ML-KEM variants, the //! feature flag `pre-verification` gives access to, as yet, unverified -//! implementations of ML-KEM that are optimized for SIMD instruction sets. The -//! `pre-verification` flag in combination with the `kyber` flag also gives -//! access to an, as yet, unverified implementation of Kyber as submitted in -//! Round 3 of the NIST PQ competition. +//! implementations of ML-KEM that are optimized for SIMD instruction sets. +//! +//! ### Kyber Round 3 +//! The `kyber` flag (in combination with `pre-verification`) also gives access +//! to an, as yet, unverified implementation of Kyber as submitted in Round 3 of +//! the NIST PQ competition. //! #![no_std]