Merge rust-bitcoin/rust-bitcoin#3933: Improve docs on `Denomination`

7c7fc36784 Improve docs on Denomination (Tobin C. Harding)

Pull request description:

  Document what each denomination means.

ACKs for top commit:
  jamillambert:
    ACK 7c7fc36784
  apoelstra:
    ACK 7c7fc36784603480df1975f4a77ec583b74efa5c; successfully ran local tests; sure

Tree-SHA512: c0f3a5172e4dfdc6195efc34f36d65700591fe19015e455aa20cacaacc9c516518cec7716028779fd408e8a639eb4a5962a372b1d1d70db06a0ea8130c3bd703
This commit is contained in:
merge-script 2025-01-21 04:24:10 +00:00
commit 8dfd0bdbb1
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 6 additions and 6 deletions

View File

@ -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,
}