fix : document-private-items ci

Author: ocdbytes

provekit/prover/src/bigint_mod.rs

@@ -622,7 +622,7 @@ pub fn ec_point_add(
     (x3, y3)
 }
 
-/// EC scalar multiplication via double-and-add: returns [scalar]*P.
+/// EC scalar multiplication via double-and-add: returns \[scalar\]*P.
 pub fn ec_scalar_mul(
     px: &[u64; 4],
     py: &[u64; 4],

provekit/r1cs-compiler/src/msm/ec_points.rs

@@ -115,8 +115,8 @@ fn point_select_unchecked<F: FieldOps>(
 
 /// Builds a point table for windowed scalar multiplication.
 ///
-/// T[0] = P (dummy entry, used when window digit = 0)
-/// T[1] = P, T[2] = 2P, T[i] = T[i-1] + P for i >= 3.
+/// T\[0\] = P (dummy entry, used when window digit = 0)
+/// T\[1\] = P, T\[2\] = 2P, T\[i\] = T\[i-1\] + P for i >= 3.
 fn build_point_table<F: FieldOps>(
     ops: &mut F,
     px: F::Elem,
@@ -137,8 +137,8 @@ fn build_point_table<F: FieldOps>(
     table
 }
 
-/// Selects T[d] from a point table using bit witnesses, where `d = Σ bits[i] *
-/// 2^i`.
+/// Selects T\[d\] from a point table using bit witnesses, where `d = Σ
+/// bits\[i\] * 2^i`.
 ///
 /// Uses a binary tree of `point_select`s: processes bits from MSB to LSB,
 /// halving the candidate set at each level. Total: `(2^w - 1)` point selects
@@ -180,10 +180,10 @@ fn table_lookup<F: FieldOps>(
 ///
 /// Structure per window (from MSB to LSB):
 ///   1. `w` shared doublings on accumulator
-///   2. Table lookup in T_P[d1] for s1's window digit
-///   3. point_add(acc, T_P[d1]) + is_zero(d1) + point_select
-///   4. Table lookup in T_R[d2] for s2's window digit
-///   5. point_add(acc, T_R[d2]) + is_zero(d2) + point_select
+///   2. Table lookup in T_P\[d1\] for s1's window digit
+///   3. point_add(acc, T_P\[d1\]) + is_zero(d1) + point_select
+///   4. Table lookup in T_R\[d2\] for s2's window digit
+///   5. point_add(acc, T_R\[d2\]) + is_zero(d2) + point_select
 ///
 /// Returns the final accumulator (x, y).
 pub fn scalar_mul_glv<F: FieldOps>(

provekit/r1cs-compiler/src/msm/mod.rs

@@ -680,10 +680,10 @@ fn decompose_point_to_limbs(
     }
 }
 
-/// FakeGLV verification for a single point: verifies R = [s]P.
+/// FakeGLV verification for a single point: verifies R = \[s\]P.
 ///
 /// Decomposes s via half-GCD into sub-scalars (s1, s2) and verifies
-/// [s1]P + [s2]R = O using interleaved windowed scalar mul with
+/// \[s1\]P + \[s2\]R = O using interleaved windowed scalar mul with
 /// half-width scalars.
 ///
 /// Returns the mutable references back to the caller for continued use.
@@ -853,7 +853,7 @@ fn decompose_witness_to_limbs(
     limbs
 }
 
-/// Recompose limbs back into a single witness: val = Σ limb[i] *
+/// Recompose limbs back into a single witness: val = Σ limb\[i\] *
 /// 2^(i*limb_bits)
 fn recompose_limbs(compiler: &mut NoirToR1CSCompiler, limbs: &[usize], limb_bits: u32) -> usize {
     let terms: Vec<SumTerm> = limbs

provekit/r1cs-compiler/src/msm/multi_limb_arith.rs

@@ -196,9 +196,9 @@ pub fn compute_is_zero(compiler: &mut NoirToR1CSCompiler, value: usize) -> usize
 
 /// (a + b) mod p for multi-limb values.
 ///
-/// Per limb i: v_i = a[i] + b[i] + 2^W - q*p[i] + carry_{i-1}
+/// Per limb i: v_i = a\[i\] + b\[i\] + 2^W - q*p\[i\] + carry_{i-1}
 ///             carry_i = floor(v_i / 2^W)
-///             r[i] = v_i - carry_i * 2^W
+///             r\[i\] = v_i - carry_i * 2^W
 pub fn add_mod_p_multi(
     compiler: &mut NoirToR1CSCompiler,
     range_checks: &mut BTreeMap<u32, Vec<usize>>,
@@ -359,8 +359,8 @@ pub fn sub_mod_p_multi(
 /// (a * b) mod p for multi-limb values using schoolbook multiplication.
 ///
 /// Verifies: a·b = p·q + r in base W = 2^limb_bits.
-/// Column k: Σ_{i+j=k} a[i]*b[j] + carry_{k-1} + OFFSET
-///         = Σ_{i+j=k} p[i]*q[j] + r[k] + carry_k * W
+/// Column k: Σ_{i+j=k} a\[i\]*b\[j\] + carry_{k-1} + OFFSET
+///         = Σ_{i+j=k} p\[i\]*q\[j\] + r\[k\] + carry_k * W
 pub fn mul_mod_p_multi(
     compiler: &mut NoirToR1CSCompiler,
     range_checks: &mut BTreeMap<u32, Vec<usize>>,
@@ -561,8 +561,8 @@ pub fn inv_mod_p_multi(
 }
 
 /// Proves r < p by decomposing (p-1) - r into non-negative multi-limb values.
-/// Uses borrow propagation: d[i] = (p-1)[i] - r[i] + borrow_in - borrow_out *
-/// 2^W
+/// Uses borrow propagation: d\[i\] = (p-1)\[i\] - r\[i\] + borrow_in -
+/// borrow_out * 2^W
 fn less_than_p_check_multi(
     compiler: &mut NoirToR1CSCompiler,
     range_checks: &mut BTreeMap<u32, Vec<usize>>,