Skip to content

Fixed 'PrimeField' docstrings #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
DrPeterVanNostrand wants to merge 1 commit into from
Closed

Fixed 'PrimeField' docstrings #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<Self, PrimeFieldDecodingError>;

/// 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.
Expand Down