From dabfea7e217b129d10f0f787722626f388dddb5a Mon Sep 17 00:00:00 2001 From: Marko Bencun Date: Thu, 16 Jan 2020 16:52:09 +0100 Subject: [PATCH] field: extend docstring of secp256k1_fe_normalize --- src/field.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/field.h b/src/field.h index bb6692a..8283e4b 100644 --- a/src/field.h +++ b/src/field.h @@ -32,10 +32,12 @@ #include "util.h" -/** Normalize a field element. */ +/** Normalize a field element. This brings the field element to a canonical representation, reduces + * its magnitude to 1, and reduces it modulo field size `p`. + */ static void secp256k1_fe_normalize(secp256k1_fe *r); -/** Weakly normalize a field element: reduce it magnitude to 1, but don't fully normalize. */ +/** Weakly normalize a field element: reduce its magnitude to 1, but don't fully normalize. */ static void secp256k1_fe_normalize_weak(secp256k1_fe *r); /** Normalize a field element, without constant-time guarantee. */