[jira] [Commented] (ARROW-13239) [Doc][Python] Dataset.head function doesn't mention required argument

["Joris Van den Bossche (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-13239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17372842#comment-17372842 ] 

Joris Van den Bossche commented on ARROW-13239:
-----------------------------------------------

It's not just {{head}}, it seems to be the problem with all methods on the Dataset / Scanner classes. For example, the {{Table}} reference documentation correctly includes the arguments in the signature, so it seems dataset.pyx related.

> [Doc][Python] Dataset.head function doesn't mention required argument
> ---------------------------------------------------------------------
>
>                 Key: ARROW-13239
>                 URL: https://issues.apache.org/jira/browse/ARROW-13239
>             Project: Apache Arrow
>          Issue Type: Bug
>          Components: Documentation, Python
>    Affects Versions: 4.0.1
>            Reporter: Alessandro Molina
>            Assignee: Alessandro Molina
>            Priority: Major
>             Fix For: 5.0.0
>
>
> It seems that some function signatures are wrongly reported in the autogenerated reference.
> I found at least one instance in {{pyarrow.dataset.Dataset.head}} which is documented as a function without any argument ( https://arrow.apache.org/docs/python/generated/pyarrow.dataset.Dataset.html#pyarrow.dataset.Dataset.head ) but in reality it requires one argument ( https://github.com/apache/arrow/blob/master/python/pyarrow/_dataset.pyx#L477 )
> I tested also by building documentation locally and the argument is not listed.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)