[GitHub] [arrow] pitrou commented on a diff in pull request #14632: MINOR: [Docs][C++] Improve docs for ConcatenateTables

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

pitrou commented on code in PR #14632:
URL: https://github.com/apache/arrow/pull/14632#discussion_r1021478926


##########
cpp/src/arrow/table.h:
##########
@@ -286,7 +286,18 @@ struct ARROW_EXPORT ConcatenateTablesOptions {
   static ConcatenateTablesOptions Defaults() { return {}; }
 };
 
-/// \brief Construct table from multiple input tables.
+/// \brief Construct a new table from multiple input tables. Underlying column arrays
+/// are concatenated without copying except in case of schema missmatch in which case
+/// columns will be cast to promoted types which will cause a copy. Tables will be
+/// concatenated in order they are provided in and order of rows within tables will be
+/// preserved.

Review Comment:
   We should keep the brief line brief. I'd also like to suggest some wording changes.
   
   ```suggestion
   /// \brief Construct a new table from multiple input tables.
   ///
   /// The new table is assembled from existing column chunks without copying,
   /// if schemas are identical. If schemas do not match exactly, an attempt is
   /// made to unify them, and then column chunks are converted to their
   /// respective unified datatype, which will probably incur a copy.
   ///
   /// Tables are concatenated in order they are provided in and the order of
   /// rows within tables will be preserved.
   ```
   



-- 
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