From 3ff307f9464ee00d8f606cb7df2a849d46c791f3 Mon Sep 17 00:00:00 2001 From: str4d Date: Mon, 7 Jun 2021 19:34:48 +0100 Subject: [PATCH] docs: Clarify EnableFlagInstructions::enable_flag --- src/circuit/gadget/utilities/enable_flag.rs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/circuit/gadget/utilities/enable_flag.rs b/src/circuit/gadget/utilities/enable_flag.rs index 5da59aa8..a024f634 100644 --- a/src/circuit/gadget/utilities/enable_flag.rs +++ b/src/circuit/gadget/utilities/enable_flag.rs @@ -8,8 +8,7 @@ use pasta_curves::arithmetic::FieldExt; use std::marker::PhantomData; pub trait EnableFlagInstructions: UtilitiesInstructions { - /// Given a `value` and an `enable_flag`, check that either `value = 0` - /// or `enable_flag = 1`. + /// Enforces that `value` be zero or, if non-zero, that `enable_flag` must be 1. fn enable_flag( &self, layouter: impl Layouter,