Skip to content

Commit

Permalink
updates gen fn references in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
supinie committed Jun 19, 2024
1 parent 3859aba commit e0dc52d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/kem.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use sha3::{
use subtle::{ConditionallySelectable, ConstantTimeEq};
use tinyvec::ArrayVec;

/// `PrivateKey` struct that can only be generated via the [`generate_key_pair`] function
/// `PrivateKey` struct that can only be generated via the [`generate_keypair_512`], [`generate_keypair_768`], or [`generate_keypair_1024`] functions
/// and is used to [`decapsulate`](PrivateKey::decapsulate) a shared secret from a given ciphertext.
///
/// Can be accessed in byte form by packing into a `u8` array using the [`pack`](PrivateKey::pack) method,
Expand All @@ -29,7 +29,7 @@ pub struct PrivateKey {
z: [u8; SYMBYTES],
}

/// `PublicKey` struct that can only be generated via the [`generate_key_pair`] or from the
/// `PublicKey` struct that can only be generated via the [`generate_keypair_512`], [`generate_keypair_768`], or [`generate_keypair_1024`] functions or from the
/// corresponding [`PrivateKey`] struct using the [`get_public_key`](PrivateKey::get_public_key)
/// method and is used to [`encapsulate`](PublicKey::encapsulate) a shared secret.
///
Expand Down

0 comments on commit e0dc52d

Please sign in to comment.