[GitHub] [arrow] edponce commented on a change in pull request #12671: ARROW-15976: [C++] Clean up commenting on execution plan example

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

edponce commented on a change in pull request #12671:
URL: https://github.com/apache/arrow/pull/12671#discussion_r831742877



##########
File path: cpp/examples/arrow/execution_plan_documentation_examples.cc
##########
@@ -579,14 +567,13 @@ arrow::Status SourceGroupAggregateSinkExample(cp::ExecContext& exec_context) {
 // (Doc section: Group Aggregate Example)
 
 // (Doc section: ConsumingSink Example)
-/**
- * \brief
- * Source-ConsumingSink
- * This example shows how the data can be consumed within the execution plan
- * by using a ConsumingSink node. There is no data output from this execution plan.
- * \param exec_context : execution context
- * \return arrow::Status
- */
+
+/// \brief An example showing a consuming sink node
+/// \param exec_context The execution context to run the plan in
+///
+/// Source-ConsumingSink

Review comment:
       Nit: `Source-Consuming-Sink`

##########
File path: cpp/examples/arrow/execution_plan_documentation_examples.cc
##########
@@ -641,16 +628,14 @@ arrow::Status SourceConsumingSinkExample(cp::ExecContext& exec_context) {
 
 // (Doc section: OrderBySink Example)
 
-/**
- * \brief
- * Source-OrderBySink
- * In this example, the data enters through the source node
- * and the data is ordered in the sink node. The order can be
- * ASCENDING or DESCENDING and it is configurable. The output
- * is obtained as a table from the sink node.
- * \param exec_context : execution context
- * \return arrow::Status
- */
+/// \brief An example showing an order-by node
+/// \param exec_context The execution context to run the plan in
+///
+/// Source-OrderBySink

Review comment:
       Similar to previous: `Source-OrderBy-Sink`

##########
File path: cpp/examples/arrow/execution_plan_documentation_examples.cc
##########
@@ -98,22 +98,21 @@ arrow::Result<std::shared_ptr<arrow::RecordBatch>> GetSampleRecordBatch(
   return record_batch->FromStructArray(struct_result);
 }
 
-/**
- * \brief Get a Table object
- *  Creating Table
- *  a, b
-    1,null
-    2,true
-    null,true
-    3,false
-    null,true
-    4,false
-    5,null
-    6,false
-    7,false
-    8,true
- * \return arrow::Result<std::shared_ptr<arrow::Table>>
- */
+/// \brief Create a sample table
+/// The table's contents will be:
+/// a, b
+/// 1,null

Review comment:
       Nit: `a, b` has an extra whitespace.




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