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

Posted to issues@beam.apache.org by "Brian Hulette (Jira)" <ji...@apache.org> on 2021/03/31 01:17:00 UTC

[jira] [Commented] (BEAM-12074) Add API Documentation for the DataFrame API

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

Brian Hulette commented on BEAM-12074:
--------------------------------------

A couple problems here: 
- beam uses google style docstrings, while pandas uses numpy style (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy)
- generally sphinx isn't happy with arbitrary section names (like "Beam DataFrame API Divergences"), but it looks like you can define custom ones (https://github.com/sphinx-contrib/napoleon/issues/2)


> Add API Documentation for the DataFrame API
> -------------------------------------------
>
>                 Key: BEAM-12074
>                 URL: https://issues.apache.org/jira/browse/BEAM-12074
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-py-core
>            Reporter: Brian Hulette
>            Priority: P2
>              Labels: dataframe-api
>          Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> For the most part this can be pulled directly from pandas methods, but we should add specific notes about any divergences that the Beam DataFrame API has from pandas.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)