Add dummy doc for nightly

arkworks-rs · Oct 21, 2024 · f374720 · f374720
1 parent 780d9dc
commit f374720
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/poly-commit/src/lib.rs b/poly-commit/src/lib.rs
@@ -620,6 +620,7 @@ fn lc_query_set_to_poly_query_set<'a, F: Field, T: Clone + Ord>(
     poly_query_set
 }
 
+/// Dummy doc
 #[cfg(test)]
 pub mod tests {
     use crate::*;
@@ -645,6 +646,7 @@ pub mod tests {
         sponge: fn() -> S,
     }
 
+    /// Dummy doc
     pub fn bad_degree_bound_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -738,6 +740,7 @@ pub mod tests {
         Ok(())
     }
 
+    /// Dummy doc
     fn test_template<F, P, PC, S>(info: TestInfo<F, P, S>) -> Result<(), PC::Error>
     where
         F: PrimeField,
@@ -879,6 +882,7 @@ pub mod tests {
         Ok(())
     }
 
+    /// Dummy doc
     fn equation_test_template<F, P, PC, S>(info: TestInfo<F, P, S>) -> Result<(), PC::Error>
     where
         F: PrimeField,
@@ -1060,6 +1064,7 @@ pub mod tests {
         Ok(())
     }
 
+    /// Dummy doc
     pub fn single_poly_test<F, P, PC, S>(
         num_vars: Option<usize>,
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
@@ -1088,6 +1093,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn linear_poly_degree_bound_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -1115,6 +1121,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn single_poly_degree_bound_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -1142,6 +1149,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn quadratic_poly_degree_bound_multiple_queries_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -1169,6 +1177,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn single_poly_degree_bound_multiple_queries_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -1196,6 +1205,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn two_polys_degree_bound_single_query_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,
@@ -1223,6 +1233,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn full_end_to_end_test<F, P, PC, S>(
         num_vars: Option<usize>,
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
@@ -1251,6 +1262,7 @@ pub mod tests {
         test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn full_end_to_end_equation_test<F, P, PC, S>(
         num_vars: Option<usize>,
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
@@ -1279,6 +1291,7 @@ pub mod tests {
         equation_test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn single_equation_test<F, P, PC, S>(
         num_vars: Option<usize>,
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
@@ -1307,6 +1320,7 @@ pub mod tests {
         equation_test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn two_equation_test<F, P, PC, S>(
         num_vars: Option<usize>,
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
@@ -1335,6 +1349,7 @@ pub mod tests {
         equation_test_template::<F, P, PC, S>(info)
     }
 
+    /// Dummy doc
     pub fn two_equation_degree_bound_test<F, P, PC, S>(
         rand_poly: fn(usize, Option<usize>, &mut ChaCha20Rng) -> P,
         rand_point: fn(Option<usize>, &mut ChaCha20Rng) -> P::Point,

diff --git a/poly-commit/src/streaming_kzg/mod.rs b/poly-commit/src/streaming_kzg/mod.rs
@@ -101,6 +101,7 @@ pub use data_structures::*;
 pub use space::CommitterKeyStream;
 pub use time::CommitterKey;
 
+/// Dummy docs
 #[cfg(test)]
 pub mod tests;