From 477f5af3614e035c17ea79cd912af2517b67450f Mon Sep 17 00:00:00 2001
From: Guillaume Bort <guillaume.bort@datadoghq.com>
Date: Sat, 3 Feb 2024 18:44:56 +0100
Subject: [PATCH] Fix misleading BigInt rustdoc (#1379)

* Fix misleading BigInt rustdoc

The original documentation was unclear about the value of the bool. I interpreted it as being `true` if the value was truncated.
---
 src/bigint.rs | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/bigint.rs b/src/bigint.rs
index bc68e3c9..4ed0cfba 100644
--- a/src/bigint.rs
+++ b/src/bigint.rs
@@ -79,9 +79,9 @@ impl BigInt {
   }
 
   /// Returns the value of this BigInt as an unsigned 64-bit integer, and a
-  /// `bool` indicating whether the return value was truncated was truncated or
-  /// wrapped around. In particular, it will be `false` if this BigInt is
-  /// negative.
+  /// `bool` indicating that the conversion was lossless when `true`.
+  /// The boolean value will be `false` if the return value was truncated or wrapped around,
+  /// in particular if the BigInt is negative.
   #[inline(always)]
   pub fn u64_value(&self) -> (u64, bool) {
     let mut lossless = MaybeUninit::uninit();
@@ -91,7 +91,8 @@ impl BigInt {
   }
 
   /// Returns the value of this BigInt as a signed 64-bit integer, and a `bool`
-  /// indicating whether this BigInt was truncated or not.
+  /// indicating that the conversion was lossless when `true`.
+  /// The boolean value will be `false` if the return value was truncated or wrapped around.
   #[inline(always)]
   pub fn i64_value(&self) -> (i64, bool) {
     let mut lossless = MaybeUninit::uninit();