From f1e2564821686f620fe1c99f0ba7e4e0ab551576 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Mon, 20 Jan 2025 13:34:09 +1100 Subject: [PATCH] Improve docs on parse::int_from_string I only just worked on this function a week ago and already I couldn't see from reading the code why it exists. Add a paragraph to the rustdocs to save the next guy the trouble of working it out. --- units/src/parse.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/units/src/parse.rs b/units/src/parse.rs index 316186953..01adc3a01 100644 --- a/units/src/parse.rs +++ b/units/src/parse.rs @@ -76,6 +76,11 @@ mod sealed { /// Parses the input string as an integer returning an error carrying rich context. /// +/// Apart from the rich error context this function exists so that we can handle builds with and +/// without an allocator. If an allocator is available (`alloc` feature enabled) then this function +/// allocates to copy the input string into the error return. If `alloc` is not enabled the input +/// string is lost. +/// /// If the caller has a `String` or `Box` which is not used later it's better to call /// [`parse::int_from_string`] or [`parse::int_from_box`] respectively. ///