[Python][Doc] Make docstrings conform to same style

[asfimport]

Probably all docstrings should conform to numpy style

Reporter: Alessandro Molina / @amol-
Assignee: Alessandro Molina / @amol-

Related issues:

• [Documentation] Documentation Improvements (is a child of)

Original Issue Attachments:

• undocumented.txt

PRs and other links:

• GitHub Pull Request #11245

_{Note: This issue was originally created as ARROW-13637. Please see the migration documentation for further details.}

[asfimport]

Joris Van den Bossche / @jorisvandenbossche:
AFAIK, all our docstrings are already written in the "numpydoc standard" format (https://numpydoc.readthedocs.io/en/latest/format.html).

We might certainly not follow it strictly everywhere, but I think fixing this / checking for this is covered by eg ARROW-12718 or ARROW-13208 ? (see also ARROW-12645, ARROW-7898, ARROW-7874 for other closed issues related to fixing numpydoc aspects)

[asfimport]

Alessandro Molina / @amol-:
@pitrou you originally mentioned this one, do you have any example of docstring that needs to be fixed that you can share?

[asfimport]

Antoine Pitrou / @pitrou:
Isn't there a bunch of examples in #7732 ?

[asfimport]

Joris Van den Bossche / @jorisvandenbossche:
@amol- is your goal for this issue to document more arguments? (for which now documentation is missing) If so maybe update the title of the issue to reflect that?

For the pyarrow.compute cases in the list you added in the attachment, for most of those the docstring is autogenerated. And we don't yet automatically include the docstring for the parameters from the options class (I thought we had a separate JIRA for that, but don't directly find it)

[asfimport]

Antoine Pitrou / @pitrou:
Issue resolved by pull request 11245
#11245