docs: Clarify EnableFlagInstructions::enable_flag

This commit is contained in:
str4d 2021-06-07 19:34:48 +01:00 committed by GitHub
parent 54c8cfd1d0
commit 3ff307f946
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 2 deletions

View File

@ -8,8 +8,7 @@ use pasta_curves::arithmetic::FieldExt;
use std::marker::PhantomData;
pub trait EnableFlagInstructions<F: FieldExt>: UtilitiesInstructions<F> {
/// 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<F>,