Skip to content

Commit

Permalink
Add documentation corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
AlenkaF committed May 11, 2023
1 parent ec29c6f commit a71fc25
Show file tree
Hide file tree
Showing 5 changed files with 284 additions and 282 deletions.
2 changes: 1 addition & 1 deletion docs/source/cpp/api/compute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Abstract Function classes
Function execution
------------------

.. doxygengroup:: compute-functions-executor
.. doxygengroup:: compute-function-executor
:content-only:
:members:

Expand Down
1 change: 1 addition & 0 deletions docs/source/cpp/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ Examples
cmake_minimal_build
compute_and_write_example
dataset_documentation_example
dataset_skyhook_scan_example
row_columnar_conversion
std::tuple-like ranges to Arrow <tuple_range_conversion>
3 changes: 2 additions & 1 deletion docs/source/cpp/streaming_execution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Read Relations

* The ``projection`` property is not supported and plans containing this
property will be rejected.
* The ``VirtualTable`` and ``ExtensionTable``read types are not supported.
* The ``VirtualTable`` and ``ExtensionTable`` read types are not supported.
Plans containing these types will be rejected.
* Only the parquet and arrow file formats are currently supported.
* All URIs must use the ``file`` scheme
Expand Down Expand Up @@ -279,6 +279,7 @@ Functions

* The functions above should be referenced using the URI
``https://github.com/apache/arrow/blob/main/format/substrait/extension_types.yaml``

* Alternatively, the URI can be left completely empty and Acero will match
based only on function name. This fallback mechanism is non-standard and should
be avoided if possible.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developers/cpp/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ build times if they are not required for your application:
options should be sufficient. However, if you wish to build any tests/benchmarks
then ``ARROW_JSON`` is also required (it will be enabled automatically).
If extended format support is desired then adding ``ARROW_PARQUET``, ``ARROW_CSV``,
``ARROW_JSON``, or ``ARROW_ORC`` shouldn't enable any additional components.
``ARROW_JSON``, or ``ARROW_ORC`` shouldn't enable any additional components.

.. note::
In general, it's a good idea to enable ``ARROW_COMPUTE`` if you anticipate using
Expand Down
Loading

0 comments on commit a71fc25

Please sign in to comment.