Improve docs on Denomination

Document what each denomination means.
2025-01-20 16:06:48 +11:00 · 2025-01-20 16:06:48 +11:00 · 7c7fc36784
parent 05c28cf31d
commit 7c7fc36784
1 changed files with 6 additions and 6 deletions
--- a/units/src/amount/mod.rs
+++ b/units/src/amount/mod.rs
@ -68,17 +68,17 @@ pub use self::{
 #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
 #[non_exhaustive]
 pub enum Denomination {
-    /// BTC
+    /// BTC (1 BTC = 100,000,000 satoshi).
    Bitcoin,
-    /// cBTC
+    /// cBTC (1 cBTC = 1,000,000 satoshi).
    CentiBitcoin,
-    /// mBTC
+    /// mBTC (1 mBTC = 100,000 satoshi).
    MilliBitcoin,
-    /// uBTC
+    /// uBTC (1 uBTC = 100 satoshi).
    MicroBitcoin,
-    /// bits
+    /// bits (bits = uBTC).
    Bit,
-    /// satoshi
+    /// satoshi (1 BTC = 100,000,000 satoshi).
    Satoshi,
 }