Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(halo2_proofs): Improve MockProver::verify description #837

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(halo2_proofs): Improve MockProver::verify description #837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions halo2_proofs/src/dev.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down