Skip to content

Commit 6d3d2fc

Browse files
authored
MINOR: [Docs][C++] Improve Input Shapes section of Compute doc (#35720)
1. The function that only takes arrays should be `array_sort_indices`, not `sort_indices`. 2. IMO The word `either` implies that `array_sort_indices` also accepts chunked arrays but in fact it doesn't. So I changed `either` to `particular input types`. 3. There are no mention of two dimensional data types, i.e. RecordBatch and Table, throughout the Input Shapes section, which I feel like is a miss. So I added `sort_indices` as an example for them. Authored-by: Jin Shang <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>
1 parent ce095e4 commit 6d3d2fc

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/source/cpp/compute.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ Computation inputs are represented as a general :class:`Datum` class,
4949
which is a tagged union of several shapes of data such as :class:`Scalar`,
5050
:class:`Array` and :class:`ChunkedArray`. Many compute functions support
5151
both array (chunked or not) and scalar inputs, however some will mandate
52-
either. For example, while ``sort_indices`` requires its first and only
53-
input to be an array.
52+
particular input types. For example, while ``array_sort_indices`` requires its
53+
first and only input to be an array, the generalized ``sort_indices``
54+
function accepts an array, chunked array, record batch or table.
5455

5556
.. _invoking-compute-functions:
5657

0 commit comments

Comments
 (0)