From b8c36bd3624a5661e5ccf55f8a8036d089c27c95 Mon Sep 17 00:00:00 2001 From: DrPeterVanNostrand Date: Mon, 10 Sep 2018 21:56:19 +0000 Subject: [PATCH] Fixed 'PrimeField' docstrings. --- src/lib.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index a9d117f..28c3f14 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -262,11 +262,12 @@ pub trait PrimeField: Field { Some(res) } - /// Convert this prime field element into a biginteger representation. + /// Converts a field element, represented as a biginteger, to a `PrimeField` + /// field element. Returns an error if the biginteger is not an element of + /// this prime field. fn from_repr(Self::Repr) -> Result; - /// Convert a biginteger representation into a prime field element, if - /// the number is an element of the field. + /// Returns the biginteger representation of this `PrimeField` field element. fn into_repr(&self) -> Self::Repr; /// Returns the field characteristic; the modulus.