pitrou commented on code in PR #13527:
URL: https://github.com/apache/arrow/pull/13527#discussion_r918981965
##########
cpp/src/arrow/engine/substrait/serde.h:
##########
@@ -36,193 +36,193 @@ namespace arrow {
namespace engine {
/// Factory function type for generating the node that consumes the batches
produced by
-/// each toplevel Substrait relation when deserializing a Substrait Plan.
+/// each top-level Substrait relation when deserializing a Substrait Plan.
using ConsumerFactory =
std::function<std::shared_ptr<compute::SinkNodeConsumer>()>;
-/// \brief Deserializes a Substrait Plan message to a list of ExecNode
declarations
+/// \brief Deserializes a Substrait Plan message to a list of ExecNode
declarations.
Review Comment:
While we are at it, can we follow the convention of using the infinitive in
function summaries.
```suggestion
/// \brief Deserialize a Substrait Plan message to a list of ExecNode
declarations.
```
##########
cpp/src/arrow/engine/substrait/serde.h:
##########
@@ -36,193 +36,193 @@ namespace arrow {
namespace engine {
/// Factory function type for generating the node that consumes the batches
produced by
-/// each toplevel Substrait relation when deserializing a Substrait Plan.
+/// each top-level Substrait relation when deserializing a Substrait Plan.
using ConsumerFactory =
std::function<std::shared_ptr<compute::SinkNodeConsumer>()>;
-/// \brief Deserializes a Substrait Plan message to a list of ExecNode
declarations
+/// \brief Deserializes a Substrait Plan message to a list of ExecNode
declarations.
Review Comment:
While we are at it, can we follow the convention of using the infinitive in
function summaries?
```suggestion
/// \brief Deserialize a Substrait Plan message to a list of ExecNode
declarations.
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
