doc: improve Bump::(try_)new

bluurryy · Dec 5, 2024 · dbef44e · dbef44e
1 parent eb6b5e3
commit dbef44e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/bump.rs b/src/bump.rs
@@ -281,6 +281,8 @@ where
     error_behavior_generic_methods_allocation_failure! {
         // TODO: Change this to say that this is *currently* equivalent to that, or perhaps don't mention 512 at all.
         //       This should only be done in a semver breaking release, considering how matter-of-factly it is stated here.
+        /// Constructs a new `Bump` with a default size hint for the first chunk.
+        ///
         impl
         /// This is equivalent to <code>[with_size](Bump::with_size)(512)</code>.
         #[must_use]