concatenate.cc: Fix docstring about the out parameter

apache · Jul 15, 2024 · 66fdfed · 66fdfed
1 parent 6a4236c
commit 66fdfed
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/cpp/src/arrow/array/concatenate.cc b/cpp/src/arrow/array/concatenate.cc
@@ -921,6 +921,8 @@ namespace internal {
 Result<std::shared_ptr<Array>> Concatenate(
     const ArrayVector& arrays, MemoryPool* pool,
     std::shared_ptr<DataType>* out_suggested_cast) {
+  DCHECK(out_suggested_cast);
+  *out_suggested_cast = nullptr;
   if (arrays.size() == 0) {
     return Status::Invalid("Must pass at least one array");
   }

diff --git a/cpp/src/arrow/array/concatenate.h b/cpp/src/arrow/array/concatenate.h
@@ -30,10 +30,9 @@ namespace internal {
 ///
 /// \param[in] arrays a vector of arrays to be concatenated
 /// \param[in] pool memory to store the result will be allocated from this memory pool
-/// \param[out] out_suggested_cast if non-NULL, the function might set it to a cast
-///                                suggestion that would allow concatenating the arrays
-///                                without overflow of offsets (e.g. string to
-///                                large_string)
+/// \param[out] out_suggested_cast if a non-OK Result is returned, the function might set
+///   out_suggested_cast to a cast suggestion that would allow concatenating the arrays
+///   without overflow of offsets (e.g. string to large_string)
 ///
 /// \return the concatenated array
 ARROW_EXPORT