ARROW-8407: [Rust] Add documentation for Dictionary data type

Add documentation for Dictionary data type Closes #6904 from andygrove/rustdoc-dictionary-type Authored-by: Andy Grove <andygrove73@gmail.com> Signed-off-by: Krisztián Szűcs <szucs.krisztian@gmail.com>
apache · Apr 13, 2020 · cabfb8f · cabfb8f
1 parent a33c294
commit cabfb8f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/rust/arrow/src/array/array.rs b/rust/arrow/src/array/array.rs
@@ -1782,7 +1782,7 @@ impl From<(Vec<(Field, ArrayRef)>, Buffer, usize)> for StructArray {
     }
 }
 
-/// A dictonary array where each element is a single value indexed by an integer key.
+/// A dictionary array where each element is a single value indexed by an integer key.
 /// This is mostly used to represent strings or a limited set of primitive types as integers,
 /// for example when doing NLP analysis or representing chromosomes by name.
 ///

diff --git a/rust/arrow/src/datatypes.rs b/rust/arrow/src/datatypes.rs
@@ -122,6 +122,8 @@ pub enum DataType {
     FixedSizeList(Box<DataType>, i32),
     /// A nested datatype that contains a number of sub-fields.
     Struct(Vec<Field>),
+    /// A dictionary array where each element is a single value indexed by an integer key.
+    /// This is mostly used to represent strings or a limited set of primitive types as integers.
     Dictionary(Box<DataType>, Box<DataType>),
 }