clarify boolean value in DataType::Dictionary (#718)

jorgecarleitao · Dec 28, 2021 · ad54610 · ad54610
1 parent d14ae86
commit ad54610
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/datatypes/mod.rs b/src/datatypes/mod.rs
@@ -128,6 +128,8 @@ pub enum DataType {
     ///
     /// This type mostly used to represent low cardinality string
     /// arrays or a limited set of primitive types as integers.
+    ///
+    /// The `bool` value indicates the `Dictionary` is sorted if set to `true`.
     Dictionary(IntegerType, Box<DataType>, bool),
     /// Decimal value with precision and scale
     /// precision is the number of digits in the number and