This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-3.4
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.4 by this push:
new ac9594dd002 [MINOR][CONNECT][PYTHON][DOCS] Fix the doc of parameter
`num` in `DataFrame.offset`
ac9594dd002 is described below
commit ac9594dd002488956ef36550e5f2adc8de4cd51b
Author: Ruifeng Zheng <[email protected]>
AuthorDate: Fri Apr 21 10:30:52 2023 +0900
[MINOR][CONNECT][PYTHON][DOCS] Fix the doc of parameter `num` in
`DataFrame.offset`
### What changes were proposed in this pull request?
fix the incorrect doc
### Why are the changes needed?
the description of parameter `num` is incorrect, it actually describes the
`num` in `DataFrame.{limit, tail}`
### Does this PR introduce _any_ user-facing change?
yes
### How was this patch tested?
existing UT
Closes #40872 from zhengruifeng/fix_doc_offset.
Authored-by: Ruifeng Zheng <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
(cherry picked from commit a28d2d7e900e8e2c65953fddbf32708802c4a700)
Signed-off-by: Hyukjin Kwon <[email protected]>
---
python/pyspark/sql/connect/dataframe.py | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/python/pyspark/sql/connect/dataframe.py
b/python/pyspark/sql/connect/dataframe.py
index 1555be7778f..ca2e1b7a0dc 100644
--- a/python/pyspark/sql/connect/dataframe.py
+++ b/python/pyspark/sql/connect/dataframe.py
@@ -1718,8 +1718,7 @@ class DataFrame:
Parameters
----------
num : int
- Number of records to return. Will return this number of records
- or all records if the DataFrame contains less than this number of
records.
+ Number of records to skip.
Returns
-------
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
