You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@arrow.apache.org by "Wes McKinney (JIRA)" <ji...@apache.org> on 2019/01/09 16:54:00 UTC

[jira] [Updated] (ARROW-2684) [Python] Various documentation improvements

     [ https://issues.apache.org/jira/browse/ARROW-2684?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Wes McKinney updated ARROW-2684:
--------------------------------
    Fix Version/s: 0.12.0

> [Python] Various documentation improvements
> -------------------------------------------
>
>                 Key: ARROW-2684
>                 URL: https://issues.apache.org/jira/browse/ARROW-2684
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Python
>            Reporter: Dominik Moritz
>            Priority: Major
>             Fix For: 0.12.0
>
>
> The python documentation is currently not beginner friendly and things like the IPC format are not discoverable. For example, [https://arrow.apache.org/docs/python/ipc.html] has the word "IPC" only in the title. Also, it's currently not clear how to write a file to disk.
> I propose that the documentation becomes more of an API docs rather than a set of examples. Examples are valuable but they cannot replace documentation of the inputs and outputs of various functions. 
> See [https://github.com/apache/arrow/issues/2119] for more. 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)