[GitHub] [beam] TheNeuralBit commented on a change in pull request #14876: [WIP][BEAM-12074] Define docstrings for all DataFrame operations

[GitBox <gi...@apache.org>]

TheNeuralBit commented on a change in pull request #14876:
URL: https://github.com/apache/beam/pull/14876#discussion_r645896483



##########
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:
       Done!

##########
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:
       Done, thanks!




-- 
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:
users@infra.apache.org