docs: added doc comment to assert messages

noir-lang · Aug 11, 2023 · e423ee9 · e423ee9
1 parent 001e7f7
commit e423ee9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/acir/src/circuit/mod.rs b/acir/src/circuit/mod.rs
@@ -30,6 +30,8 @@ pub struct Circuit {
     /// The set of public inputs calculated within the circuit.
     pub return_values: PublicInputs,
     /// Maps opcode locations to failed assertion messages.
+    /// These messages are embedded in the circuit to provide useful feedback to users
+    /// when a constraint in the circuit is not satisfied.
     pub assert_messages: BTreeMap<OpcodeLocation, String>,
 }