Comments'

Author: ngernest

protocols/src/diagnostic.rs

@@ -453,6 +453,12 @@ impl DiagnosticHandler {
         }
     }
 
+    /// Emits an error message when an `assert_eq` fails. Arguments are:
+    /// - The enclosing `Transaction`
+    /// - The `ExprId`s of the two arguments to the `assert_eq`
+    /// - The values that the two `Expr`s evaluate to
+    /// - The arguments `todo_args` supplied to the transaction
+    ///   (for more info in the error msg)
     pub fn emit_diagnostic_assertion(
         &mut self,
         tr: &Transaction,

protocols/src/errors.rs

@@ -638,6 +638,14 @@ pub type ExecutionResult<T> = Result<T, ExecutionError>;
 pub struct DiagnosticEmitter;
 
 impl DiagnosticEmitter {
+    /// Emits an error message that corresponds to a failure when
+    /// executing a protocol. Arguments are:
+    /// - The `DiagnosticHandler`
+    /// - The actual error
+    /// - The transaction which contained the error
+    /// - The relevant `SymbolTable` (for resolving variable names)
+    /// - The arguments (`todo_args`) supplied to the transaction
+    ///   (for extra info in the error message)
     pub fn emit_execution_error(
         handler: &mut DiagnosticHandler,
         error: &ExecutionError,