Docstring and #[doc(hidden)] for Montgomery form inside of Fp mod…

…el (arkworks-rs#682)
mmagician · Sep 13, 2023 · 494830d · 494830d
1 parent 85546e4
commit 494830d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/ff/src/fields/models/fp/mod.rs b/ff/src/fields/models/fp/mod.rs
@@ -113,6 +113,9 @@ pub trait FpConfig<const N: usize>: Send + Sync + 'static + Sized {
     Eq(bound = "")
 )]
 pub struct Fp<P: FpConfig<N>, const N: usize>(
+    /// Contains the element in Montgomery form for efficient multiplication.
+    /// To convert an element to a [`BigInt`](struct@BigInt), use `into_bigint` or `into`.
+    #[doc(hidden)]
     pub BigInt<N>,
     #[derivative(Debug = "ignore")]
     #[doc(hidden)]