Merge rust-bitcoin/rust-bitcoin#2651: units: Release tracking PR: `0.1.0` - BOOM!

a05da2294e units: Add an initial changelog (Tobin C. Harding)
36ef4a62cf units: Improve re-exports (Tobin C. Harding)

Pull request description:

  In preparation for release do two things:

  - Patch 1: Attempt to improve the re-exports and HTML docs
  - Patch 2: Add an initial changelog file

  Note the version number is set already and does not conflict with the current `v0.0.0` version: https://crates.io/crates/bitcoin-units

ACKs for top commit:
  sanket1729:
    utACK a05da2294e
  apoelstra:
    ACK a05da2294e

Tree-SHA512: ab78f89d2e29e58e840d64889f0b7e0e57335e610b8759490478511854f1a7606e8203e4201872eaeb16a96fc527ecdca35e13b39027218d8f71290591e68101
This commit is contained in:
Andrew Poelstra 2024-04-03 13:02:09 +00:00
commit aefc791dd7
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
2 changed files with 25 additions and 1 deletions

17
units/CHANGELOG.md Normal file
View File

@ -0,0 +1,17 @@
# 0.1.0 - Initial Release - 2024-04-03
Initial release of the `bitcoin-units` crate. These unit types are
integer wrapper types used by the `rust-bitcoin` ecosystem. Note
please that this release relies heavily on the "alloc" feature.
The main types are:
- `Amount`
- `locktime::absolute::{Height, Time}`
- `locktime::relative::{Height, Time}`
- `FeeRate`
- `Weight`
# 0.0.0 - Placeholder release
Empty crate to reserve the name on crates.io

View File

@ -46,9 +46,16 @@ pub mod parse;
pub mod weight; pub mod weight;
#[doc(inline)] #[doc(inline)]
pub use self::amount::{Amount, ParseAmountError, SignedAmount}; pub use self::amount::{Amount, SignedAmount};
pub use self::amount::ParseAmountError;
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
pub use self::parse::ParseIntError; pub use self::parse::ParseIntError;
#[cfg(feature = "alloc")]
#[doc(inline)]
pub use self::{
fee_rate::FeeRate,
weight::Weight,
};
#[rustfmt::skip] #[rustfmt::skip]
#[allow(unused_imports)] #[allow(unused_imports)]