This is an automated email from the ASF dual-hosted git repository.
brycemecum pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 3d5e9aaede MINOR: [Docs] Fix broken link in acero/options.h docstring
(#40811)
3d5e9aaede is described below
commit 3d5e9aaedecadee9daa86232ec58de422caecdb6
Author: Bryce Mecum <[email protected]>
AuthorDate: Wed Mar 27 19:39:44 2024 -0800
MINOR: [Docs] Fix broken link in acero/options.h docstring (#40811)
### Rationale for this change
A "See also" link at
https://arrow.apache.org/docs/cpp/api/acero.html#_CPPv4N5arrow5acero22TableSourceNodeOptionsE
isn't automatically linked, probably because SourceNode itself isn't
documented.
### What changes are included in this PR?
I updated the string to be "SourceNodeOptions" so it links there, which I'm
pretty sure is what was intended because TableSourceNode inherits from
SourceNode and the docs for SourceNodeOptions documents the behavior of
SourceNode.
### Are these changes tested?
Yes, locally.
### Are there any user-facing changes?
Just docs.
Authored-by: Bryce Mecum <[email protected]>
Signed-off-by: Bryce Mecum <[email protected]>
---
cpp/src/arrow/acero/options.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/cpp/src/arrow/acero/options.h b/cpp/src/arrow/acero/options.h
index 1ede3fbfc8..4447e9c67a 100644
--- a/cpp/src/arrow/acero/options.h
+++ b/cpp/src/arrow/acero/options.h
@@ -105,8 +105,8 @@ class ARROW_ACERO_EXPORT SourceNodeOptions : public
ExecNodeOptions {
/// \brief a node that generates data from a table already loaded in memory
///
/// The table source node will slice off chunks, defined by `max_batch_size`
-/// for parallel processing. The source node extends source node and so these
-/// chunks will be iteratively processed in small batches. \see SourceNode
+/// for parallel processing. The table source node extends source node and so
these
+/// chunks will be iteratively processed in small batches. \see
SourceNodeOptions
/// for details.
class ARROW_ACERO_EXPORT TableSourceNodeOptions : public ExecNodeOptions {
public:
