You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Alessandro Molina (Jira)" <ji...@apache.org> on 2021/07/01 14:19:00 UTC

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

Alessandro Molina created ARROW-13239:
-----------------------------------------

             Summary: [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
             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)