This is an automated email from the ASF dual-hosted git repository.
ruifengz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new f65129d3a53 [SPARK-41330][CONNECT][PYSPARK][DOC] Improve Documentation
for Take,Tail, Limit and Offset
f65129d3a53 is described below
commit f65129d3a53e1cd58418268ccc1f900a1ee8eb16
Author: Rui Wang <rui.w...@databricks.com>
AuthorDate: Wed Nov 30 14:21:36 2022 +0800
[SPARK-41330][CONNECT][PYSPARK][DOC] Improve Documentation for Take,Tail,
Limit and Offset
### What changes were proposed in this pull request?
For `Tail`, `Take`, `Limit`, `Offset`. Current documentation says `whataver
number is available` when the parameter is smaller than the entire dataset
size. This PR re-phrases it to say the all the records in the dataframe.
### Why are the changes needed?
Improve documentation.
### Does this PR introduce _any_ user-facing change?
NO
### How was this patch tested?
N/A
Closes #38845 from amaliujia/fix_pyspark_comment.
Authored-by: Rui Wang <rui.w...@databricks.com>
Signed-off-by: Ruifeng Zheng <ruife...@apache.org>
---
python/pyspark/sql/connect/dataframe.py | 4 ++--
python/pyspark/sql/dataframe.py | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/python/pyspark/sql/connect/dataframe.py
b/python/pyspark/sql/connect/dataframe.py
index 08ad9954672..ef70336e31d 100644
--- a/python/pyspark/sql/connect/dataframe.py
+++ b/python/pyspark/sql/connect/dataframe.py
@@ -421,7 +421,7 @@ class DataFrame(object):
----------
num : int
Number of records to return. Will return this number of records
- or whataver number is available.
+ or all records if the DataFrame contains less than this number of
records..
Returns
-------
@@ -456,7 +456,7 @@ class DataFrame(object):
----------
num : int
Number of records to return. Will return this number of records
- or whatever number is available.
+ or all records if the DataFrame contains less than this number of
records.
Returns
-------
diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py
index 61e628c9015..f3873e3c8cd 100644
--- a/python/pyspark/sql/dataframe.py
+++ b/python/pyspark/sql/dataframe.py
@@ -1176,7 +1176,7 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
----------
num : int
Number of records to return. Will return this number of records
- or whataver number is available.
+ or all records if the DataFrame contains less than this number of
records.
Returns
-------
@@ -1211,7 +1211,7 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
----------
num : int
Number of records to return. Will return this number of records
- or whataver number is available.
+ or all records if the DataFrame contains less than this number of
records..
Returns
-------
@@ -1243,7 +1243,7 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
----------
num : int
Number of records to return. Will return this number of records
- or whataver number is available.
+ or all records if the DataFrame contains less than this number of
records.
Returns
-------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
