add better explanatory comment for Take

apache · Apr 8, 2019 · 14e837e · 14e837e
1 parent e94fe31
commit 14e837e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/cpp/src/arrow/compute/kernels/take.h b/cpp/src/arrow/compute/kernels/take.h
@@ -43,6 +43,14 @@ struct ARROW_EXPORT TakeOptions {
 };
 
 /// \brief Take from one array type to another
+///
+/// The output array will be of the same type as the input values
+/// array, with elements taken from the values array at the given
+/// indices.
+///
+/// For example given values ["a", "b", "c"] and indices
+/// [2, 1], the output will be ["c", "b"].
+///
 /// \param[in] context the FunctionContext
 /// \param[in] values array from which to take
 /// \param[in] indices which values to take