This is an automated email from the ASF dual-hosted git repository.
dongjoon 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 8ccc8b92be50 [SPARK-48201][DOCS][PYTHON] Make some corrections in the
docstring of pyspark DataStreamReader methods
8ccc8b92be50 is described below
commit 8ccc8b92be50b1d5ef932873403e62e28c478781
Author: Chloe He <ch...@chloe-mac.lan>
AuthorDate: Thu May 9 22:07:04 2024 -0700
[SPARK-48201][DOCS][PYTHON] Make some corrections in the docstring of
pyspark DataStreamReader methods
### What changes were proposed in this pull request?
The docstrings of the pyspark DataStream Reader methods `csv()` and
`text()` say that the `path` parameter can be a list, but actually when a list
is passed an error is raised.
### Why are the changes needed?
Documentation is wrong.
### Does this PR introduce _any_ user-facing change?
Yes. Fixes documentation.
### How was this patch tested?
N/A
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #46416 from chloeh13q/fix/streamread-docstring.
Authored-by: Chloe He <ch...@chloe-mac.lan>
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
python/pyspark/sql/streaming/readwriter.py | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/python/pyspark/sql/streaming/readwriter.py
b/python/pyspark/sql/streaming/readwriter.py
index c2b75dd8f167..b202a499e8b0 100644
--- a/python/pyspark/sql/streaming/readwriter.py
+++ b/python/pyspark/sql/streaming/readwriter.py
@@ -553,8 +553,8 @@ class DataStreamReader(OptionUtils):
Parameters
----------
- path : str or list
- string, or list of strings, for input path(s).
+ path : str
+ string for input path.
Other Parameters
----------------
@@ -641,8 +641,8 @@ class DataStreamReader(OptionUtils):
Parameters
----------
- path : str or list
- string, or list of strings, for input path(s).
+ path : str
+ string for input path.
schema : :class:`pyspark.sql.types.StructType` or str, optional
an optional :class:`pyspark.sql.types.StructType` for the input
schema
or a DDL-formatted string (For example ``col0 INT, col1 DOUBLE``).
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
