[
https://issues.apache.org/jira/browse/ARROW-10317?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17466886#comment-17466886
]
Antoine Pitrou commented on ARROW-10317:
----------------------------------------
One way to do this on the Python side would be to write regular Numpy-formatted
docstrings for the options classes, then to parse them using {{numpydoc}} so as
to extract parameter descriptions and inject them into the generated compute
function docstrings.
We could for example vendor the {{docscrape}} module from {{numpydoc}}:
https://github.com/numpy/numpydoc/blob/main/numpydoc/docscrape.py
[~jorisvandenbossche] Does it sound reasonable?
> [C++] Consider adding documentation for FunctionOption classes
> --------------------------------------------------------------
>
> Key: ARROW-10317
> URL: https://issues.apache.org/jira/browse/ARROW-10317
> Project: Apache Arrow
> Issue Type: Improvement
> Components: C++, Python
> Reporter: Antoine Pitrou
> Priority: Major
> Fix For: 7.0.0
>
>
> This would allow generating improved documentation for bindings (e.g. Python).
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
