Skip to content

Commit a5d90df

Browse files
committed
Add documentation for Sign enum fields
1 parent 575cea4 commit a5d90df

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/bigint.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,11 @@ mod shift;
3434
/// A `Sign` is a [`BigInt`]'s composing element.
3535
#[derive(PartialEq, PartialOrd, Eq, Ord, Copy, Clone, Debug, Hash)]
3636
pub enum Sign {
37+
/// The value of the [`BigInt`] is equal to its absolute value multiplied by `-1`.
3738
Minus,
39+
/// The value of the [`BigInt`] is equal to its absolute value multiplied by `0`.
3840
NoSign,
41+
/// The value of the [`BigInt`] is equal to its absolute value multiplied by `1`.
3942
Plus,
4043
}
4144

0 commit comments

Comments
 (0)