Fix documentation links (#28)
Pratyush Mishra pratyushmishra@berkeley.edu
Wed, 23 Dec 2020 19:46:02 -0800
2 files changed,
6 insertions(+),
4 deletions(-)
M
src/bits/boolean.rs
→
src/bits/boolean.rs
@@ -689,7 +689,8 @@ /// Conditionally selects one of `first` and `second` based on the value of
/// `self`: /// /// If `self.is_eq(&Boolean::TRUE)`, this outputs `first`; else, it outputs - /// `second`. ``` + /// `second`. + /// ``` /// # fn main() -> Result<(), ark_relations::r1cs::SynthesisError> { /// // We'll use the BLS12-381 scalar field for our constraints. /// use ark_test_curves::bls12_381::Fr;@@ -710,6 +711,7 @@ /// assert!(cs.is_satisfied().unwrap());
/// # Ok(()) /// # } /// ``` + /// #[tracing::instrument(target = "r1cs", skip(first, second))] pub fn select<T: CondSelectGadget<F>>( &self,
M
src/groups/curves/short_weierstrass/mod.rs
→
src/groups/curves/short_weierstrass/mod.rs
@@ -9,15 +9,15 @@
use crate::{fields::fp::FpVar, prelude::*, ToConstraintFieldGadget, Vec}; /// 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; /// 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. pub mod mnt4; /// 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. pub mod mnt6;