Elaborate the documentation of accumulation

Partially fixes [privacy-scaling-explorations#72](input-output-hk/galois_recursion#72)
input-output-hk · Jan 23, 2024 · d90d572 · d90d572
1 parent eb474cb
commit d90d572
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/halo2_proofs/src/poly/ipa/folding.rs b/halo2_proofs/src/poly/ipa/folding.rs
@@ -1,5 +1,13 @@
-//! This module contains the accumulation/folding of the IPA polynomial commitment
-//! scheme described in the [BCMS20][bcms20] paper.
+//! # IPA Polynomial Commitment Accumulation Module
+//!
+//! This module is dedicated to the implementation of the accumulation/folding process
+//! as described in the [BCMS20][bcms20] paper, specifically in Section 7.1. It
+//! includes a Rust implementation of the accumulation prover, verifier (`strategy.process()`),
+//! and decider (`strategy.finalize()`) functionalities outlined in this section.
+//!
+//! The Rust-based accumulation verifier serves both as a standalone implementation
+//! and as a reference for verifying the forthcoming circuit implementation's
+//! equivalence.
 //!
 //! [bcms20]: https://eprint.iacr.org/2020/499
 

diff --git a/halo2_proofs/src/poly/ipa/mod.rs b/halo2_proofs/src/poly/ipa/mod.rs
@@ -1,5 +1,4 @@
 pub mod commitment;
-/// IPA folding scheme
 pub mod folding;
 /// Multiscalar multiplication engines
 pub mod msm;