This is an automated email from the ASF dual-hosted git repository.
bkietz 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 9d4dcc903e GH-38847: [Documentation][C++] Explicitly note that compute
is optional (#43629)
9d4dcc903e is described below
commit 9d4dcc903e84732a6e14d61aece1f9a1d096f7c9
Author: Benjamin Kietzman <[email protected]>
AuthorDate: Mon Aug 19 14:01:57 2024 -0500
GH-38847: [Documentation][C++] Explicitly note that compute is optional
(#43629)
### Rationale for this change
A user didn't know from reading just the compute documentation that compute
is an optional feature. We can make that explicit
### What changes are included in this PR?
Added a cross-reference to the optional features section
### Are these changes tested?
No
### Are there any user-facing changes?
No
* GitHub Issue: #38847
Authored-by: Benjamin Kietzman <[email protected]>
Signed-off-by: Benjamin Kietzman <[email protected]>
---
docs/source/cpp/tutorials/compute_tutorial.rst | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/source/cpp/tutorials/compute_tutorial.rst
b/docs/source/cpp/tutorials/compute_tutorial.rst
index a650865d75..72ebc35650 100644
--- a/docs/source/cpp/tutorials/compute_tutorial.rst
+++ b/docs/source/cpp/tutorials/compute_tutorial.rst
@@ -39,7 +39,9 @@ Pre-requisites
Before continuing, make sure you have:
-1. An Arrow installation, which you can set up here: :doc:`/cpp/build_system`
+1. An Arrow installation, which you can set up here: :doc:`/cpp/build_system`.
+ If you're compiling Arrow yourself, be sure you compile with the compute
module
+ enabled (i.e., ``-DARROW_COMPUTE=ON``), see
:ref:`cpp_build_optional_components`.
2. An understanding of basic Arrow data structures from
:doc:`/cpp/tutorials/basic_arrow`
@@ -50,7 +52,7 @@ Before running some computations, we need to fill in a couple
gaps:
1. We need to include necessary headers.
-2. ``A main()`` is needed to glue things together.
+2. A ``main()`` is needed to glue things together.
3. We need data to play with.
