Skip to content

Commit a64c16f

Browse files
authored
primefield: align monty_field_element! docs with actual API (#1593)
1 parent 90185ac commit a64c16f

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

primefield/src/macros.rs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,6 @@ macro_rules! monty_field_params {
9292
/// - `Mul`
9393
/// - `MulAssign`
9494
/// - `Neg`
95-
/// - `Shr`
96-
/// - `ShrAssign`
9795
/// - `Invert`
9896
#[macro_export]
9997
macro_rules! monty_field_element {
@@ -120,7 +118,7 @@ macro_rules! monty_field_element {
120118

121119
/// Create a [`
122120
#[doc = stringify!($fe)]
123-
/// `] from a canonical big-endian representation.
121+
/// `] from a canonical byte representation using the field's configured byte order.
124122
pub fn from_bytes(
125123
repr: &$crate::MontyFieldBytes<$params, { <$params>::LIMBS }>,
126124
) -> $crate::subtle::CtOption<Self> {
@@ -129,15 +127,15 @@ macro_rules! monty_field_element {
129127

130128
/// Decode [`
131129
#[doc = stringify!($fe)]
132-
/// `] from a big endian byte slice.
130+
/// `] from a byte slice using the field's configured byte order.
133131
pub fn from_slice(slice: &[u8]) -> Option<Self> {
134132
$crate::MontyFieldElement::<$params, { <$params>::LIMBS }>::from_slice(slice)
135133
.map(Self)
136134
}
137135

138136
/// Decode a [`
139137
#[doc = stringify!($fe)]
140-
/// `] from big endian hex-encoded bytes.
138+
/// `] from hex-encoded bytes using the field's configured byte order.
141139
///
142140
/// This is primarily intended for defining constants using hex literals.
143141
///

0 commit comments

Comments
 (0)