From a5d90df5e6e1681f43c2185044da0a470621f7bb Mon Sep 17 00:00:00 2001 From: Charles Parham Date: Wed, 10 Sep 2025 23:02:23 -0700 Subject: [PATCH] Add documentation for Sign enum fields --- src/bigint.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/bigint.rs b/src/bigint.rs index b4f84b9e..32225eb2 100644 --- a/src/bigint.rs +++ b/src/bigint.rs @@ -34,8 +34,11 @@ mod shift; /// A `Sign` is a [`BigInt`]'s composing element. #[derive(PartialEq, PartialOrd, Eq, Ord, Copy, Clone, Debug, Hash)] pub enum Sign { + /// The value of the [`BigInt`] is equal to its absolute value multiplied by `-1`. Minus, + /// The value of the [`BigInt`] is equal to its absolute value multiplied by `0`. NoSign, + /// The value of the [`BigInt`] is equal to its absolute value multiplied by `1`. Plus, }