[
https://issues.apache.org/jira/browse/ARROW-13665?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17401168#comment-17401168
]
Antoine Pitrou commented on ARROW-13665:
----------------------------------------
Also cc [~amol-]
> [C++][Python] Generated argument description for compute meta-functions not
> accurate
> ------------------------------------------------------------------------------------
>
> Key: ARROW-13665
> URL: https://issues.apache.org/jira/browse/ARROW-13665
> Project: Apache Arrow
> Issue Type: Bug
> Components: C++, Python
> Reporter: Antoine Pitrou
> Priority: Minor
>
> Examples:
> {code}
> >>> ?pc.drop_null
> Signature: pc.drop_null(input, *, memory_pool=None)
> Docstring:
> Drop nulls from the input.
> The output is populated with values from the input (Array, ChunkedArray,
> RecordBatch, or Table) without the null values.
> For the RecordBatch and Table cases, `drop_null` drops the full row if
> there is any null.
> Parameters
> ----------
> input : Array-like or scalar-like
> Argument to compute function
> memory_pool : pyarrow.MemoryPool, optional
> If not passed, will allocate memory from the default memory pool.
> File: ~/arrow/dev/python/pyarrow/compute.py
> Type: function
> >>> ?pc.sort_indices
> Signature: pc.sort_indices(input, *, memory_pool=None, options=None,
> sort_keys=None)
> Docstring:
> Return the indices that would sort an array, record batch or table.
> This function computes an array of indices that define a stable sort
> of the input array, record batch or table. Null values are considered
> greater than any other value and are therefore sorted at the end of the
> input. For floating-point types, NaNs are considered greater than any
> other non-null value, but smaller than null values.
> Parameters
> ----------
> input : Array-like or scalar-like
> Argument to compute function
> memory_pool : pyarrow.MemoryPool, optional
> If not passed, will allocate memory from the default memory pool.
> options : pyarrow.compute.SortOptions, optional
> Parameters altering compute function semantics
> **kwargs : optional
> Parameters for SortOptions constructor. Either `options`
> or `**kwargs` can be passed, but not both at the same time.
> File: ~/arrow/dev/python/pyarrow/compute.py
> Type: function
> {code}
> These two functions accepts arrays, chunked arrays, record batches and
> tables, but "input" says "Array-like or scalar-like".
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
