chore: document truncate (#2082)

document trauncate
noir-lang · Jul 28, 2023 · c21e63f · c21e63f
1 parent 63c4da0
commit c21e63f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/noirc_evaluator/src/ssa_refactor/acir_gen/acir_ir/acir_variable.rs b/crates/noirc_evaluator/src/ssa_refactor/acir_gen/acir_ir/acir_variable.rs
@@ -579,6 +579,8 @@ impl AcirContext {
     }
 
     /// Returns an `AcirVar` which will be constrained to be lhs mod 2^{rhs}
+    /// In order to do this, we simply perform euclidian division of lhs by 2^{rhs}
+    /// The remainder of the division is then lhs mod 2^{rhs}
     pub(crate) fn truncate_var(
         &mut self,
         lhs: AcirVar,