Skip to content

docs: align group_digest docs with hash2field API #1651

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

Open
radik878 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: align group_digest docs with hash2field API #1651

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
13 changes: 8 additions & 5 deletions hash2curve/src/group_digest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ pub trait GroupDigest: MapToCurve {
/// Computes the hash to curve routine.
/// See [`GroupDigest::hash_from_bytes()`] for more details.
///
/// For the `expand_message` call, `len_in_bytes = <Self::FieldElement as FromOkm>::Length * 2`.
/// This value must be less than `u16::MAX` or otherwise a compiler error will occur.
/// For the `expand_message` call in the underlying [`hash_to_field`] routine,
/// `len_in_bytes = C::Length * 2` (see [`MapToCurve::Length`]). This value must be
/// less than `u16::MAX` or otherwise a compiler error will occur.
///
/// # Errors
///
Expand All @@ -96,7 +97,8 @@ where
/// Computes the encode to curve routine.
/// See [`GroupDigest::encode_from_bytes()`] for more details.
///
/// For the `expand_message` call, `len_in_bytes = <Self::FieldElement as FromOkm>::Length`.
/// For the `expand_message` call in the underlying [`hash_to_field`] routine,
/// `len_in_bytes = C::Length` (see [`MapToCurve::Length`]).
///
/// # Errors
///
Expand All @@ -119,8 +121,9 @@ where
/// <https://www.rfc-editor.org/rfc/rfc9380.html#section-5-4>
/// and returns a scalar.
///
/// For the `expand_message` call, `len_in_bytes = <Self::FieldElement as FromOkm>::Length`.
/// This value must be less than `u16::MAX` or otherwise a compiler error will occur.
/// For the `expand_message` call in the underlying [`hash_to_field`] routine,
/// `len_in_bytes = L`. This value must be less than `u16::MAX` or otherwise a
/// compiler error will occur.
///
/// # Errors
///
Expand Down