[GitHub] [arrow-rs] alamb commented on a change in pull request #603: Doctests for UnionBuilder and UnionArray.

[GitBox <gi...@apache.org>]

alamb commented on a change in pull request #603:
URL: https://github.com/apache/arrow-rs/pull/603#discussion_r676128693



##########
File path: arrow/src/array/array_union.rs
##########
@@ -83,6 +27,15 @@ use std::any::Any;
 use std::mem::size_of;
 
 /// An Array that can represent slots of varying types.
+///
+/// Each slot in a `UnionArray` can have a value chosen from a number of types.  Each of the
+/// possible types are named like the fields of a [`StructArray`](crate::array::StructArray).
+/// A `UnionArray` can have two possible memory layouts, "dense" or "sparse".  For more information
+/// on please see the [specification](https://arrow.apache.org/docs/format/Columnar.html#union-layout).
+///
+/// Builders are provided for `UnionArray`'s involving primitive types.  `UnionArray`'s of nested

Review comment:
       ```suggestion
   /// [`UnionBuilder`]can be used to create  `UnionArray`'s of primitive types.  `UnionArray`'s of nested
   ```
   
   it might be nice to add a link to the UnionBuilder here so when people are browsing the docs they can click and go to the right place




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org