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/05/31 00:51:00 UTC
[jira] [Commented] (ARROW-2939) [Python] API documentation version
doesn't match latest on PyPI
[ https://issues.apache.org/jira/browse/ARROW-2939?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16852516#comment-16852516 ]
Wes McKinney commented on ARROW-2939:
-------------------------------------
The published docs are now for the latest released version. I think it would be useful to have an archive of old documentation versions, though. Removing this from the 0.14 Fix Version
> [Python] API documentation version doesn't match latest on PyPI
> ---------------------------------------------------------------
>
> Key: ARROW-2939
> URL: https://issues.apache.org/jira/browse/ARROW-2939
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Python
> Reporter: Ian Robertson
> Priority: Minor
> Labels: documentation
> Fix For: 0.14.0
>
>
> Hey folks, apologies if this isn't the right place to raise this. In poking around the web documentation (for pyarrow specifically), it looks like the auto-generated API docs contain commits past the release of 0.9.0. For example:
> * [https://arrow.apache.org/docs/python/generated/pyarrow.Table.html#pyarrow.Table.column]
> * Contains differences merged here: [https://github.com/apache/arrow/pull/1923]
> * But latest pypi/conda versions of pyarrow are 0.9.0, which don't include that change.
> Not sure if the docs are auto-built off master somewhere, I couldn't find anything about building docs in the docs itself. I would guess that you may want some of the usage docs to be published in between releases if they're not about new functionality, but the API reference being out of date can be confusing. Is it possible to anchor the API docs to the latest released version? Or even something like how Pandas has a whole bunch of old versions still available? (e.g. [https://pandas.pydata.org/pandas-docs/stable/] vs. old versions like [http://pandas.pydata.org/pandas-docs/version/0.17.0/])
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)