From f52b866e59814bd3fb999b82e9c1f4214752e726 Mon Sep 17 00:00:00 2001 From: Pratyush Mishra Date: Wed, 23 Dec 2020 19:46:02 -0800 Subject: [PATCH] Fix documentation links (#28) --- src/bits/boolean.rs | 4 +++- src/groups/curves/short_weierstrass/mod.rs | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/bits/boolean.rs b/src/bits/boolean.rs index 294ef62..c3c7dc2 100644 --- a/src/bits/boolean.rs +++ b/src/bits/boolean.rs @@ -689,7 +689,8 @@ impl Boolean { /// `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 @@ impl Boolean { /// # Ok(()) /// # } /// ``` + /// #[tracing::instrument(target = "r1cs", skip(first, second))] pub fn select>( &self, diff --git a/src/groups/curves/short_weierstrass/mod.rs b/src/groups/curves/short_weierstrass/mod.rs index d736873..938eff5 100644 --- a/src/groups/curves/short_weierstrass/mod.rs +++ b/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}; /// 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;