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

[chore] fix hyperlinks in docs #41

Merged
merged 1 commit into from
Nov 3, 2023
Merged
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
2 changes: 1 addition & 1 deletion snark-verifier/src/loader/halo2.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! `Loader` implementation for generating verifier in [`halo2_proofs`] circuit.
//! `Loader` implementation for generating verifier in [`halo2_proofs`](crate::halo2_proofs) circuit.

pub(crate) mod loader;
mod shim;
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/loader/halo2/loader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use std::{
rc::Rc,
};

/// `Loader` implementation for generating verifier in [`halo2_proofs`] circuit.
/// `Loader` implementation for generating verifier in [`halo2_proofs`](crate::halo2_proofs) circuit.
#[derive(Debug)]
pub struct Halo2Loader<C: CurveAffine, EccChip: EccInstructions<C>> {
ecc_chip: RefCell<EccChip>,
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/pcs/ipa/multiopen/bgh19.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use std::{
};

/// Verifier of multi-open inner product argument. It is for the implementation
/// in [`halo2_proofs`], which is previously <https://eprint.iacr.org/2019/1021>
/// in [`halo2_proofs`](crate::halo2_proofs), which is previously <https://eprint.iacr.org/2019/1021>
/// .
#[derive(Clone, Debug)]
pub struct Bgh19;
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/pcs/kzg/multiopen/bdfg21.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use std::{
};

/// Verifier of multi-open KZG. It is for the SHPLONK implementation
/// in [`halo2_proofs`].
/// in [`halo2_proofs`](crate::halo2_proofs).
/// Notations are following <https://eprint.iacr.org/2020/081>.
#[derive(Clone, Debug)]
pub struct Bdfg21;
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/pcs/kzg/multiopen/gwc19.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::{
};

/// Verifier of multi-open KZG. It is for the GWC implementation
/// in [`halo2_proofs`].
/// in [`halo2_proofs`](crate::halo2_proofs).
/// Notations are following <https://eprint.iacr.org/2019/953.pdf>.
#[derive(Clone, Debug)]
pub struct Gwc19;
Expand Down
6 changes: 3 additions & 3 deletions snark-verifier/src/system/halo2.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! [`halo2_proofs`] proof system
//! [`halo2_proofs`](crate::halo2_proofs) proof system

use crate::halo2_proofs::{
plonk::{self, Any, ConstraintSystem, FirstPhase, SecondPhase, ThirdPhase, VerifyingKey},
Expand All @@ -21,7 +21,7 @@ use std::{io, iter, mem::size_of};
pub mod strategy;
pub mod transcript;

/// Configuration for converting a [`VerifyingKey`] of [`halo2_proofs`] into
/// Configuration for converting a [`VerifyingKey`] of [`halo2_proofs`](crate::halo2_proofs) into
/// [`PlonkProtocol`].
#[derive(Clone, Debug, Default)]
pub struct Config {
Expand Down Expand Up @@ -78,7 +78,7 @@ impl Config {
}
}

/// Convert a [`VerifyingKey`] of [`halo2_proofs`] into [`PlonkProtocol`].
/// Convert a [`VerifyingKey`] of [`halo2_proofs`](crate::halo2_proofs) into [`PlonkProtocol`].
pub fn compile<'a, C: CurveAffine, P: Params<'a, C>>(
params: &P,
vk: &VerifyingKey<C>,
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/system/halo2/transcript/evm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ where
}

/// Does not allow the input to be a one-byte sequence, because the Transcript trait only supports writing scalars and elliptic curve points.
/// If the one-byte sequence [0x01] is a valid input to the transcript, the empty input [] will have the same transcript result as [0x01].
/// If the one-byte sequence `[0x01]` is a valid input to the transcript, the empty input `[]` will have the same transcript result as `[0x01]`.
fn squeeze_challenge(&mut self) -> Scalar {
let len = if self.buf.len() == 0x20 {
assert_eq!(self.loader.ptr(), self.buf.end());
Expand Down
2 changes: 1 addition & 1 deletion snark-verifier/src/util/arithmetic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use std::{
ops::{Add, AddAssign, Mul, MulAssign, Neg, Sub, SubAssign},
};

/// [`halo2_curves::pairing::MultiMillerLoop`] with [`std::fmt::Debug`].
/// [pairing::MultiMillerLoop] with [`std::fmt::Debug`].
pub trait MultiMillerLoop: pairing::MultiMillerLoop + Debug {}

impl<M: pairing::MultiMillerLoop + Debug> MultiMillerLoop for M {}
Expand Down
Loading