Skip to content

Commit 29dfd20

Browse files
committed
fix(docs)
1 parent e8475a5 commit 29dfd20

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

src/errors.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! # ProofError: Error Types for Zero-Knowledge Proofs
22
//!
3-
//! This module defines the [`ProofError`] enum, which encapsulates possible errors that may occur
3+
//! This module defines the [`Error`] enum, which encapsulates possible errors that may occur
44
//! during the execution of Sigma protocols or their non-interactive variants.
55
//!
66
//! These errors include:

src/fiat_shamir.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ use rand::{CryptoRng, RngCore};
2626
/// - `get_challenge`: extracts the challenge from the codec
2727
///
2828
/// # Type Parameters
29-
/// - `C`: the codec used for the underlying determenitis function.
29+
/// - `C`: the codec used for encoding/decoding messages to/from the IP space.
3030
pub trait FiatShamir<C: Codec>: SigmaProtocol {
3131
fn push_commitment(&self, codec: &mut C, commitment: &Self::Commitment);
3232

3333
fn get_challenge(&self, codec: &mut C) -> Result<Self::Challenge, Error>;
3434
}
3535

36-
/// Structures implementing this trait must implicitly have one or more underlying [`GroupMorphism`] elements.
36+
/// Structures implementing this trait must implicitly have an associated linear relation.
3737
///
3838
/// This trait allows the data of the morphisms underlying the structure to be absorbed into a codec.
3939
pub trait HasGroupMorphism {

src/group_morphism.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ impl<G: Group> GroupMap<G> {
146146

147147
/// Get the element value assigned to the given point var.
148148
///
149-
/// Returns [Error::UninitializedGroupVar] if a value is not assigned.
149+
/// Returns [`Error::UnassignedGroupVar`] if a value is not assigned.
150150
pub fn get(&self, var: GroupVar) -> Result<G, Error> {
151151
self.0[var.0].ok_or(Error::UnassignedGroupVar { var })
152152
}

0 commit comments

Comments
 (0)