[
https://issues.apache.org/jira/browse/BEAM-12074?focusedWorklogId=606309&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-606309
]
ASF GitHub Bot logged work on BEAM-12074:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 04/Jun/21 00:12
Start Date: 04/Jun/21 00:12
Worklog Time Spent: 10m
Work Description: pcoet commented on a change in pull request #14876:
URL: https://github.com/apache/beam/pull/14876#discussion_r645205789
##########
File path: sdks/python/apache_beam/dataframe/frames.py
##########
@@ -1541,9 +1568,20 @@ def __setitem__(self, key, value):
else:
raise NotImplementedError(key)
+ @frame_base.with_docs_from(pd.DataFrame)
@frame_base.args_to_kwargs(pd.DataFrame)
@frame_base.populate_defaults(pd.DataFrame)
def align(self, other, join, axis, copy, level, method, **kwargs):
+ """Aligning per-level is not yet supported. Only the default,
Review comment:
"per-level" -> "per level" (because it's technically being used as an
adverb, and ... English is weird)
##########
File path: sdks/python/apache_beam/dataframe/frames.py
##########
@@ -1541,9 +1568,20 @@ def __setitem__(self, key, value):
else:
raise NotImplementedError(key)
+ @frame_base.with_docs_from(pd.DataFrame)
@frame_base.args_to_kwargs(pd.DataFrame)
@frame_base.populate_defaults(pd.DataFrame)
def align(self, other, join, axis, copy, level, method, **kwargs):
+ """Aligning per-level is not yet supported. Only the default,
+ ``level=None``, is allowed.
+
+ Filling NaN values via ``method`` is not supported, because it is
+ `order-sensitive
+ <https://s.apache.org/dataframe-order-sensitive-operatons>`_. Only the
+ default, ``method=None``, is allowed.
+
+ ``copy=False`` is not supported because its behavior (whether or not it is
+ an inplace oepration) depends on the data."""
Review comment:
typo: "oepration"
--
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: 606309)
Time Spent: 15h 10m (was: 15h)
> 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 10m
> 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)
