[GitHub] [beam] TheNeuralBit commented on a change in pull request #14961: [BEAM-12074] Add special explanation for head/tail pointing to interactive Beam and nlargest

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

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



##########
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 "
+    ":func:`ib.collect <apache_beam.runners.interactive.interactive_beam.collect>` "
+    "with ``n`` specified may be a useful alternative.\n\n"
+    "Also consider using :meth:`DeferredDataFrame.nlargest` if you're "
+    "interested in finding the top-N elements in a dataset.")

Review comment:
       This should mention `sample` as well, but that is not supported yet.




-- 
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