Skip to content

Commit

Permalink
fix doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
plafer committed Apr 20, 2024
1 parent c787454 commit 2d78070
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions winterfell/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@
//! }
//!
//! impl Air for WorkAir {
//! // First, we'll specify which finite field to use for our computation, and also how
//! type AuxRandElements<E: Send + Sync> = ();
//! // We'll specify which finite field to use for our computation, and also how
//! // the public inputs must look like.
//! type BaseField = BaseElement;
//! type PublicInputs = PublicInputs;
Expand Down Expand Up @@ -284,6 +285,7 @@
//! # }
//! #
//! # impl Air for WorkAir {
//! # type AuxRandElements<E: Send + Sync> = ();
//! # type BaseField = BaseElement;
//! # type PublicInputs = PublicInputs;
//! #
Expand Down Expand Up @@ -338,6 +340,7 @@
//! // struct as we don't need to define a custom trace for our computation. For other
//! // associated types, we'll use default implementation provided by Winterfell.
//! impl Prover for WorkProver {
//! type AuxRandElements<E: Send + Sync> = ();
//! type BaseField = BaseElement;
//! type Air = WorkAir;
//! type Trace = TraceTable<Self::BaseField>;
Expand Down Expand Up @@ -373,10 +376,11 @@
//! &self,
//! air: &'a Self::Air,
//! aux_rand_elements: Option<Self::AuxRandElements<E>>,
//! composition_coefficients: ConstraintCompositionCoefficients<E>,
//! composition_coefficients: winterfell::ConstraintCompositionCoefficients<E>,
//! ) -> Self::ConstraintEvaluator<'a, E> {
//! DefaultConstraintEvaluator::new(air, aux_rand_elements, composition_coefficients)
//! }
//! }
//! ```
//!
//! Now, we are finally ready to generate and verify STARK proofs.
Expand Down Expand Up @@ -429,6 +433,7 @@
//! # }
//! #
//! # impl Air for WorkAir {
//! type AuxRandElements<E: Send + Sync> = ();
//! # type BaseField = BaseElement;
//! # type PublicInputs = PublicInputs;
//! #
Expand Down Expand Up @@ -477,6 +482,7 @@
//! # }
//! #
//! # impl Prover for WorkProver {
//! # type AuxRandElements<E: Send + Sync> = ();
//! # type BaseField = BaseElement;
//! # type Air = WorkAir;
//! # type Trace = TraceTable<Self::BaseField>;
Expand Down Expand Up @@ -511,7 +517,7 @@
//! # &self,
//! # air: &'a Self::Air,
//! # aux_rand_elements: Option<Self::AuxRandElements<E>>,
//! # composition_coefficients: ConstraintCompositionCoefficients<E>,
//! # composition_coefficients: winterfell::ConstraintCompositionCoefficients<E>,
//! # ) -> Self::ConstraintEvaluator<'a, E> {
//! # DefaultConstraintEvaluator::new(air, aux_rand_elements, composition_coefficients)
//! # }
Expand Down

0 comments on commit 2d78070

Please sign in to comment.