Skip to content

Commit

Permalink
doc: add comments key pair
Browse files Browse the repository at this point in the history
  • Loading branch information
Al-Kindi-0 committed Mar 15, 2024
1 parent b7d97a1 commit 66e46ef
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/dsa/falcon512/keys/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ pub use public_key::{PubKeyPoly, PublicKey};
mod secret_key;
pub use secret_key::SecretKey;

// KEY PAIR
// ================================================================================================

/// A key pair is composed of a [SecretKey] and its associated [PubKeyPoly].

Check failure on line 20 in src/dsa/falcon512/keys/mod.rs

View workflow job for this annotation

GitHub Actions / Verify the docs on stable

public documentation for `KeyPair` links to private item `PubKeyPoly`
pub struct KeyPair {
secret_key: SecretKey,
public_key: PubKeyPoly,
Expand Down

0 comments on commit 66e46ef

Please sign in to comment.