From 710f1e75741d7d0c7f0c839e719f3350a8aacb57 Mon Sep 17 00:00:00 2001
From: Daniel Lehmann <daniel@Mac.localdomain>
Date: Mon, 2 Dec 2024 12:44:20 -0800
Subject: [PATCH] Add new feature to changelog and describe trade-off of public
 feature

---
 CHANGELOG.md | 30 ++++++++++++++++++++++--------
 Cargo.toml   |  1 +
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a31fa94..269c819 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,32 +1,46 @@
 # Changelog
 
+## arbitrary-int 1.2.8
+
+### Added
+
+- New optional feature `hint`, which tells the compiler that the returned `value()` can't exceed a maximum value. This
+  allows the compiler to optimize faster code at the expense of unsafe code within arbitrary-int itself.
+
 ## arbitrary-int 1.2.7
 
 ### Added
 
-- Support `Step` so that arbitrary-int can be used in a range expression, e.g. `for n in u3::MIN..=u3::MAX { println!("{n}") }`. Note this trait is currently unstable, and so is only usable in nightly. Enable this feature with `step_trait`.
+- Support `Step` so that arbitrary-int can be used in a range expression, e.g.
+  `for n in u3::MIN..=u3::MAX { println!("{n}") }`. Note this trait is currently unstable, and so is only usable in
+  nightly. Enable this feature with `step_trait`.
 - Support formatting via [defmt](https://crates.io/crates/defmt). Enable the option `defmt` feature
 - Support serializing and deserializing via [serde](https://crates.io/crates/serde). Enable the option `serde` feature
 - Support `Mul`, `MulAssign`, `Div`, `DivAssign`
 - The following new methods were implemented to make arbitrary ints feel more like built-in types:
-     * `wrapping_add`, `wrapping_sub`, `wrapping_mul`, `wrapping_div`, `wrapping_shl`, `wrapping_shr`
-     * `saturating_add`, `saturating_sub`, `saturating_mul`, `saturating_div`, `saturating_pow`
-     * `checked_add`, `checked_sub`, `checked_mul`, `checked_div`, `checked_shl`, `checked_shr`
-     * `overflowing_add`, `overflowing_sub`, `overflowing_mul`, `overflowing_div`, `overflowing_shl`, `overflowing_shr`
+    * `wrapping_add`, `wrapping_sub`, `wrapping_mul`, `wrapping_div`, `wrapping_shl`, `wrapping_shr`
+    * `saturating_add`, `saturating_sub`, `saturating_mul`, `saturating_div`, `saturating_pow`
+    * `checked_add`, `checked_sub`, `checked_mul`, `checked_div`, `checked_shl`, `checked_shr`
+    * `overflowing_add`, `overflowing_sub`, `overflowing_mul`, `overflowing_div`, `overflowing_shl`, `overflowing_shr`
 
 ### Changed
-- In debug builds, `<<` (`Shl`, `ShlAssign`) and `>>` (`Shr`, `ShrAssign`) now bounds-check the shift amount using the same semantics as built-in shifts. For example, shifting a u5 by 5 or more bits will now panic as expected.
+
+- In debug builds, `<<` (`Shl`, `ShlAssign`) and `>>` (`Shr`, `ShrAssign`) now bounds-check the shift amount using the
+  same semantics as built-in shifts. For example, shifting a u5 by 5 or more bits will now panic as expected.
 
 ## arbitrary-int 1.2.6
 
 ### Added
 
-- Support `LowerHex`, `UpperHex`, `Octal`, `Binary` so that arbitrary-int can be printed via e.g. `format!("{:x}", u4::new(12))`
+- Support `LowerHex`, `UpperHex`, `Octal`, `Binary` so that arbitrary-int can be printed via e.g.
+  `format!("{:x}", u4::new(12))`
 - Support `Hash` so that arbitrary-int can be used in hash tables
 
 ### Changed
 
-- As support for `[const_trait]` has recently been removed from structs like `From<T>` in upstream Rust, opting-in to the `nightly` feature no longer enables this behavior as that would break the build. To continue using this feature with older compiler versions, use `const_convert_and_const_trait_impl` instead.
+- As support for `[const_trait]` has recently been removed from structs like `From<T>` in upstream Rust, opting-in to
+  the `nightly` feature no longer enables this behavior as that would break the build. To continue using this feature
+  with older compiler versions, use `const_convert_and_const_trait_impl` instead.
 
 ## arbitrary-int 1.2.5
 
diff --git a/Cargo.toml b/Cargo.toml
index 96c397d..d84c002 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -33,6 +33,7 @@ schemars = ["dep:schemars", "std"]
 
 # Provide a soundness promixe to the compiler that the unerlying value is always within range
 # This optimizes e.g. indexing range checks when passed in an API.
+# The downside of this feature is that it involves an unsafe call to `core::hint::assert_unchecked` during `value()`.
 hint = []
 
 [dependencies]