Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and grammatical errors in documentation and code comments #66

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions snark-verifier/src/loader/halo2/shim.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,14 @@ pub trait EccInstructions<'a, C: CurveAffine>: Clone + Debug {
/// Returns reference of [`EccInstructions::ScalarChip`].
fn scalar_chip(&self) -> &Self::ScalarChip;

/// Assign a elliptic curve point constant.
/// Assign an elliptic curve point constant.
fn assign_constant(
&self,
ctx: &mut Self::Context,
ec_point: C,
) -> Result<Self::AssignedEcPoint, Error>;

/// Assign a elliptic curve point witness.
/// Assign an elliptic curve point witness.
fn assign_point(
&self,
ctx: &mut Self::Context,
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/pcs/kzg/accumulator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ mod halo2 {
x.zip(y).map(|(x, y)| C::from_xy(x, y).unwrap())
}

/// Instructions to encode/decode a elliptic curve point into/from limbs.
/// Instructions to encode/decode an elliptic curve point into/from limbs.
pub trait LimbsEncodingInstructions<'a, C: CurveAffine, const LIMBS: usize, const BITS: usize>:
EccInstructions<'a, C>
{
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/util/poly.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use std::{
pub struct Polynomial<F>(Vec<F>);

impl<F> Polynomial<F> {
/// Initialize an univariate polynomial.
/// Initialize a univariate polynomial.
pub fn new(inner: Vec<F>) -> Self {
Self(inner)
}
Expand Down
4 changes: 2 additions & 2 deletions snark-verifier/src/util/transcript.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ where
(0..n).map(|_| self.read_scalar()).collect()
}

/// Read a elliptic curve point.
/// Read an elliptic curve point.
fn read_ec_point(&mut self) -> Result<L::LoadedEcPoint, Error>;

/// Read `n` elliptic curve point.
Expand All @@ -57,6 +57,6 @@ pub trait TranscriptWrite<C: CurveAffine>: Transcript<C, NativeLoader> {
/// Write a scalar.
fn write_scalar(&mut self, scalar: C::Scalar) -> Result<(), Error>;

/// Write a elliptic curve point.
/// Write an elliptic curve point.
fn write_ec_point(&mut self, ec_point: C) -> Result<(), Error>;
}