[
https://issues.apache.org/jira/browse/BEAM-12074?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17358785#comment-17358785
]
Brian Hulette commented on BEAM-12074:
--------------------------------------
Noting here we should also make sure that head() has helpful documentation
before closing this.
head() is used frequently in an interactive context to peek at data, but we
don't support it because it is order-sensitive. If users want to peek at data
they should use interactive Beam's collect method with n specified (or use
sample, when it is supported). We should direct users to these alternatives in
head's docstring and error messages.
> 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
> Assignee: Brian Hulette
> Priority: P2
> Labels: dataframe-api, stale-P2
> Time Spent: 15h 50m
> 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)
