From a3c8ff074f46d93abcdf1ca0f13b2c43026e74d4 Mon Sep 17 00:00:00 2001 From: Enrico Minack Date: Wed, 29 Jan 2025 19:39:10 +0100 Subject: [PATCH] Improve ScanNodeOptions docstring --- cpp/src/arrow/dataset/scanner.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/cpp/src/arrow/dataset/scanner.h b/cpp/src/arrow/dataset/scanner.h index 1ddd93676e85d..af8888ad873f1 100644 --- a/cpp/src/arrow/dataset/scanner.h +++ b/cpp/src/arrow/dataset/scanner.h @@ -557,8 +557,12 @@ class ARROW_DS_EXPORT ScannerBuilder { /// \brief Construct a source ExecNode which yields batches from a dataset scan. /// /// Does not construct associated filter or project nodes. -/// Yielded batches will be augmented with fragment/batch indices to enable stable -/// ordering for simple ExecPlans. +/// +/// Batches are yielded sequentially, like single-threaded, +/// when require_sequenced_output=true. +/// +/// Yielded batches will be augmented with fragment/batch indices when +/// implicit_ordering=true to enable stable ordering for simple ExecPlans. class ARROW_DS_EXPORT ScanNodeOptions : public acero::ExecNodeOptions { public: explicit ScanNodeOptions(std::shared_ptr dataset,