You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "Joris Van den Bossche (Jira)" <ji...@apache.org> on 2022/04/05 13:44:00 UTC

[jira] [Created] (ARROW-16123) [Python] Do no include __init__ in the API documentation

Joris Van den Bossche created ARROW-16123:
---------------------------------------------

             Summary: [Python] Do no include __init__ in the API documentation
                 Key: ARROW-16123
                 URL: https://issues.apache.org/jira/browse/ARROW-16123
             Project: Apache Arrow
          Issue Type: Improvement
          Components: Documentation, Python
            Reporter: Joris Van den Bossche


From https://github.com/apache/arrow/pull/12698#discussion_r836484176

We should try to instruct sphinx/autodoc/numpydoc to not include {{\_\_init\_\_}} functions in the reference docs, as I don't think we have any case where this adds value (compared to the class docstring). See eg https://arrow.apache.org/docs/dev/python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset.__init__

cc [~alenkaf]



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