From 46db3deafc5247e627e79cf19d5572cfd6dd071c Mon Sep 17 00:00:00 2001 From: benesjan Date: Mon, 15 Jul 2024 18:29:28 +0000 Subject: [PATCH] more docs --- yarn-project/foundation/src/fields/point.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/yarn-project/foundation/src/fields/point.ts b/yarn-project/foundation/src/fields/point.ts index d8be2ae78c6..3bcf4a00ede 100644 --- a/yarn-project/foundation/src/fields/point.ts +++ b/yarn-project/foundation/src/fields/point.ts @@ -102,10 +102,11 @@ export class Point { /** * Uses the x coordinate and isPositive flag (+/-) to reconstruct the point. - * @dev The y coordinate can be derived from the x coordinate and the sign flag by solving the grumpkin curve + * @dev The y coordinate can be derived from the x coordinate and the "sign" flag by solving the grumpkin curve * equation for y. * @param x - The x coordinate of the point - * @param sign - The sign of the y coordinate + * @param sign - The "sign" of the y coordinate - note that this is not a sign as is known in integer arithmetic. + * Instead it is a boolean flag that determines whether the y coordinate is <= (Fr.MODULUS - 1) / 2 * @returns The point as an array of 2 fields */ static fromXAndSign(x: Fr, sign: boolean) {