[jira] [Commented] (ARROW-16063) [Python] Refactor documentation for generic Scanner parameters

["David Li (Jira)" <ji...@apache.org>]

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

David Li commented on ARROW-16063:
----------------------------------

[~sanjibansg] attempted to do this here: [https://github.com/apache/arrow/pull/12560#discussion_r825877794]

{quote}Sorry for the late update. I tried following this approach to avoid the duplication. But while setting the docstring using the __doc__ property, the following error was thrown.
AttributeError: attribute '_\_doc__' of 'method_descriptor' objects is not writable{quote}

> [Python] Refactor documentation for generic Scanner parameters
> --------------------------------------------------------------
>
>                 Key: ARROW-16063
>                 URL: https://issues.apache.org/jira/browse/ARROW-16063
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Python
>            Reporter: Antoine Pitrou
>            Priority: Minor
>              Labels: good-second-issue
>
> A number of methods in {{_dataset.pyx}} redirect most of their arguments to {{Scanner.from_dataset}} or {{Scanner.from_fragment}}. Their docstrings usually do the same, which is a bit user-unfriendly. Instead, we should find a way to duplicate the argument descriptions in these docstrings, while keeping numpydoc checks happy.
> See original discussion at https://github.com/apache/arrow/pull/12698#discussion_r836371359



--
This message was sent by Atlassian Jira
(v8.20.1#820001)