From 9106eecad38b1385a6338109967b440d59ee23aa Mon Sep 17 00:00:00 2001
From: wowinter13 <vla-dy@yandex.ru>
Date: Mon, 20 Jan 2025 01:00:57 +0100
Subject: [PATCH] docs(halo2_proofs): Improve MockProver::verify description

---
 halo2_proofs/src/dev.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/halo2_proofs/src/dev.rs b/halo2_proofs/src/dev.rs
index a292b0ab4e..067ffd24e7 100644
--- a/halo2_proofs/src/dev.rs
+++ b/halo2_proofs/src/dev.rs
@@ -568,6 +568,11 @@ impl<F: Field + Ord> MockProver<F> {
 
     /// Returns `Ok(())` if this `MockProver` is satisfied, or a list of errors indicating
     /// the reasons that the circuit is not satisfied.
+    ///
+    /// Note: When writing positive tests (i.e. checking that a circuit is valid), prefer using
+    /// [`MockProver::assert_satisfied`] which provides more readable error output. This method
+    /// is primarily intended for writing negative tests to check that specific invalid circuit
+    /// constructions fail with expected errors.
     pub fn verify(&self) -> Result<(), Vec<VerifyFailure>> {
         let n = self.n as i32;