Skip to content

Commit 9106eec

Browse files
committed
docs(halo2_proofs): Improve MockProver::verify description
1 parent fed6b00 commit 9106eec

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

halo2_proofs/src/dev.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -568,6 +568,11 @@ impl<F: Field + Ord> MockProver<F> {
568568

569569
/// Returns `Ok(())` if this `MockProver` is satisfied, or a list of errors indicating
570570
/// the reasons that the circuit is not satisfied.
571+
///
572+
/// Note: When writing positive tests (i.e. checking that a circuit is valid), prefer using
573+
/// [`MockProver::assert_satisfied`] which provides more readable error output. This method
574+
/// is primarily intended for writing negative tests to check that specific invalid circuit
575+
/// constructions fail with expected errors.
571576
pub fn verify(&self) -> Result<(), Vec<VerifyFailure>> {
572577
let n = self.n as i32;
573578

0 commit comments

Comments
 (0)