(iceberg-rust) branch main updated: minor: Fix `double` API doc typo (#226)

[fo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fokko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git


The following commit(s) were added to refs/heads/main by this push:
     new b248fd6  minor: Fix `double` API doc typo (#226)
b248fd6 is described below

commit b248fd6bf2c69c21e84f64347ead1cb72cf28096
Author: Liang-Chi Hsieh <vi...@gmail.com>
AuthorDate: Tue Mar 5 00:30:02 2024 -0800

    minor: Fix `double` API doc typo (#226)
---
 crates/iceberg/src/spec/datatypes.rs |  6 +++---
 crates/iceberg/src/spec/values.rs    | 12 ++++++------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/crates/iceberg/src/spec/datatypes.rs b/crates/iceberg/src/spec/datatypes.rs
index 172cb64..636f14e 100644
--- a/crates/iceberg/src/spec/datatypes.rs
+++ b/crates/iceberg/src/spec/datatypes.rs
@@ -171,13 +171,13 @@ pub enum PrimitiveType {
     Int,
     /// 64-bit signed integer
     Long,
-    /// 32-bit IEEE 754 floating bit.
+    /// 32-bit IEEE 754 floating point.
     Float,
-    /// 64-bit IEEE 754 floating bit.
+    /// 64-bit IEEE 754 floating point.
     Double,
     /// Fixed point decimal
     Decimal {
-        /// Precision
+        /// Precision, must be 38 or less
         precision: u32,
         /// Scale
         scale: u32,
diff --git a/crates/iceberg/src/spec/values.rs b/crates/iceberg/src/spec/values.rs
index 688bce4..f202914 100644
--- a/crates/iceberg/src/spec/values.rs
+++ b/crates/iceberg/src/spec/values.rs
@@ -228,7 +228,7 @@ impl Datum {
         }
     }
 
-    /// Creates an 32bit floating point number.
+    /// Creates an 64bit floating point number.
     ///
     /// Example:
     /// ```rust
@@ -265,7 +265,7 @@ impl Datum {
         }
     }
 
-    /// Creates a date in `%Y-%m-%d` format, assume in utc timezone.
+    /// Creates date literal in `%Y-%m-%d` format, assume in utc timezone.
     ///
     /// See [`NaiveDate::from_str`].
     ///
@@ -289,7 +289,7 @@ impl Datum {
         Ok(Self::date(date_from_naive_date(t)))
     }
 
-    /// Create a date from calendar date (year, month and day).
+    /// Create date literal from calendar date (year, month and day).
     ///
     /// See [`NaiveDate::from_ymd_opt`].
     ///
@@ -313,9 +313,9 @@ impl Datum {
         Ok(Self::date(date_from_naive_date(t)))
     }
 
-    /// Creates time in microseconds directly.
+    /// Creates time literal in microseconds directly.
     ///
-    /// It will returns error when it's negative or too large to fit in 24 hours.
+    /// It will return error when it's negative or too large to fit in 24 hours.
     ///
     /// Example:
     ///
@@ -364,7 +364,7 @@ impl Datum {
         }
     }
 
-    /// Creates time in microseconds in `%H:%M:%S:.f` format.
+    /// Creates time literal in microseconds in `%H:%M:%S:.f` format.
     ///
     /// See [`NaiveTime::from_str`] for details.
     ///