Browse Source

Fix documentation links (#28)

master
Pratyush Mishra 3 years ago
committed by GitHub
parent
commit
f52b866e59
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions
  1. +3
    -1
      src/bits/boolean.rs
  2. +3
    -3
      src/groups/curves/short_weierstrass/mod.rs

+ 3
- 1
src/bits/boolean.rs

@ -689,7 +689,8 @@ impl Boolean {
/// `self`: /// `self`:
/// ///
/// If `self.is_eq(&Boolean::TRUE)`, this outputs `first`; else, it outputs /// If `self.is_eq(&Boolean::TRUE)`, this outputs `first`; else, it outputs
/// `second`. ```
/// `second`.
/// ```
/// # fn main() -> Result<(), ark_relations::r1cs::SynthesisError> { /// # fn main() -> Result<(), ark_relations::r1cs::SynthesisError> {
/// // We'll use the BLS12-381 scalar field for our constraints. /// // We'll use the BLS12-381 scalar field for our constraints.
/// use ark_test_curves::bls12_381::Fr; /// use ark_test_curves::bls12_381::Fr;
@ -710,6 +711,7 @@ impl Boolean {
/// # Ok(()) /// # Ok(())
/// # } /// # }
/// ``` /// ```
///
#[tracing::instrument(target = "r1cs", skip(first, second))] #[tracing::instrument(target = "r1cs", skip(first, second))]
pub fn select<T: CondSelectGadget<F>>( pub fn select<T: CondSelectGadget<F>>(
&self, &self,

+ 3
- 3
src/groups/curves/short_weierstrass/mod.rs

@ -9,15 +9,15 @@ use core::{borrow::Borrow, marker::PhantomData};
use crate::{fields::fp::FpVar, prelude::*, ToConstraintFieldGadget, Vec}; use crate::{fields::fp::FpVar, prelude::*, ToConstraintFieldGadget, Vec};
/// This module provides a generic implementation of G1 and G2 for /// This module provides a generic implementation of G1 and G2 for
/// the [[BLS12]](https://eprint.iacr.org/2002/088.pdf) family of bilinear groups.
/// the [\[BLS12]\](https://eprint.iacr.org/2002/088.pdf) family of bilinear groups.
pub mod bls12; pub mod bls12;
/// This module provides a generic implementation of G1 and G2 for /// This module provides a generic implementation of G1 and G2 for
/// the [[MNT4]](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.20.8113&rep=rep1&type=pdf)
/// the [\[MNT4]\](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.20.8113&rep=rep1&type=pdf)
/// family of bilinear groups. /// family of bilinear groups.
pub mod mnt4; pub mod mnt4;
/// This module provides a generic implementation of G1 and G2 for /// This module provides a generic implementation of G1 and G2 for
/// the [[MNT6]](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.20.8113&rep=rep1&type=pdf)
/// the [\[MNT6]\](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.20.8113&rep=rep1&type=pdf)
/// family of bilinear groups. /// family of bilinear groups.
pub mod mnt6; pub mod mnt6;

Loading…
Cancel
Save