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

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.0.1
• Fix Version/s: 5.0.0
• Component/s: Documentation, Python
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/28924
• Assignee: Alessandro Molina
• Reporter: Alessandro Molina
• Created: 01/Jul/21 14:18
• Updated: 11/Jan/23 08:31
• Resolved: 16/Jul/21 11:37

Description

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.

Issue Links

• links to: GitHub Pull Request #10684