Doc

zanmato1984 · Dec 21, 2023 · 30097f0 · 30097f0
1 parent 7299d99
commit 30097f0
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/cpp/src/arrow/testing/random.h b/cpp/src/arrow/testing/random.h
@@ -468,9 +468,10 @@ class ARROW_TESTING_EXPORT RandomArrayGenerator {
 
   /// \brief Generate a random SparseUnionArray
   ///
-  /// The type ids are chosen randomly, according to a uniform distribution,
-  /// amongst the given child fields.
+  /// The type ids are chosen randomly from `type.type_codes()`, according to a uniform
+  /// distribution, amongst the given child fields.
   ///
+  /// \param[in] type The union data type
   /// \param[in] fields Vector of Arrays containing the data for each union field
   /// \param[in] size The size of the generated sparse union array
   /// \param[in] alignment alignment for memory allocations (in bytes)
@@ -482,10 +483,11 @@ class ARROW_TESTING_EXPORT RandomArrayGenerator {
 
   /// \brief Generate a random DenseUnionArray
   ///
-  /// The type ids are chosen randomly, according to a uniform distribution,
-  /// amongst the given child fields.  The offsets are incremented along
+  /// The type ids are chosen randomly from `type.type_codes()`, according to a uniform
+  /// distribution, amongst the given child fields.  The offsets are incremented along
   /// each child field.
   ///
+  /// \param[in] type The union data type
   /// \param[in] fields Vector of Arrays containing the data for each union field
   /// \param[in] size The size of the generated sparse union array
   /// \param[in] alignment alignment for memory allocations (in bytes)