[
https://issues.apache.org/jira/browse/ARROW-2684?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17659710#comment-17659710
]
Rok Mihevc commented on ARROW-2684:
-----------------------------------
This issue has been migrated to [issue
#15729|https://github.com/apache/arrow/issues/15729] on GitHub. Please see the
[migration documentation|https://github.com/apache/arrow/issues/14542] for
further details.
> [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
> Assignee: Antoine Pitrou
> 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
(v8.20.10#820010)
