[
https://issues.apache.org/jira/browse/BEAM-12074?focusedWorklogId=608157&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-608157
]
ASF GitHub Bot logged work on BEAM-12074:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 07/Jun/21 23:16
Start Date: 07/Jun/21 23:16
Worklog Time Spent: 10m
Work Description: pcoet commented on a change in pull request #14961:
URL: https://github.com/apache/beam/pull/14961#discussion_r647000777
##########
File path: sdks/python/apache_beam/dataframe/frames.py
##########
@@ -127,6 +127,16 @@ def wrapper(self, *args, **kwargs):
return frame_base.with_docs_from(base)(wrapper)
+# Docstring to use for head and tail (commonly used to peek at datasets)
+_PEEK_METHOD_EXPLANATION = (
+ "because it is `order-sensitive
<https://s.apache.org/dataframe-order-sensitive-operations>`_.\n\n"
+ "If you'd like to use it to peek at a large dataset, interactive Beam's "
Review comment:
I prettied this up a little bit, since we're using it in a bunch of
places. But just a suggestion. No need to change:
"If you want to peek at a large dataset, consider using :func:`ib.collect
<apache_beam.runners.interactive.interactive_beam.collect>` with ``n``
specified. If you want to find the N largest elements, consider using
:meth:`DeferredDataFrame.nlargest`."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 608157)
Time Spent: 17h (was: 16h 50m)
> 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: 17h
> 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)
