Skip to content

Commit

Permalink
docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
plafer committed Feb 21, 2024
1 parent 44b4961 commit 2ac004c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion math/src/field/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,9 @@ pub trait StarkField: FieldElement<BaseField = Self> {
/// of bytes needed to represent an element.
///
/// # Panics
/// Panics if the length of `bytes` is smaller than the number of bytes needed to encode an element.
/// Panics if
/// - the length of `bytes` is greater than the number of bytes needed to encode an element.
/// - the value of the bytes is not a valid field element after padding
fn from_byte_vec_with_padding(mut bytes: Vec<u8>) -> Self {
assert!(bytes.len() < Self::ELEMENT_BYTES);

Expand Down

0 comments on commit 2ac004c

Please sign in to comment.