This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-3.1
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.1 by this push:
new a93a575 [MINOR][PYTHON][DOCS] Fix docstring for
pyspark.sql.DataFrameWriter.json lineSep param
a93a575 is described below
commit a93a575a2c1f6a97c3388c75a7ab55da2ee66410
Author: Alex Mooney <[email protected]>
AuthorDate: Wed Apr 14 13:14:51 2021 +0900
[MINOR][PYTHON][DOCS] Fix docstring for pyspark.sql.DataFrameWriter.json
lineSep param
### What changes were proposed in this pull request?
Add a new line to the `lineSep` parameter so that the doc renders correctly.
### Why are the changes needed?
> <img width="608" alt="image"
src="https://user-images.githubusercontent.com/8269566/114631408-5c608900-9c71-11eb-8ded-ae1e21ae48b2.png";>
The first line of the description is part of the signature and is
**bolded**.
### Does this PR introduce _any_ user-facing change?
Yes, it changes how the docs for `pyspark.sql.DataFrameWriter.json` are
rendered.
### How was this patch tested?
I didn't test it; I don't have the doc rendering tool chain on my machine,
but the change is obvious.
Closes #32153 from AlexMooney/patch-1.
Authored-by: Alex Mooney <[email protected]>
Signed-off-by: HyukjinKwon <[email protected]>
(cherry picked from commit faa928cefc8c1c6d7771aacd2ae7670162346361)
Signed-off-by: HyukjinKwon <[email protected]>
---
python/pyspark/sql/readwriter.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/python/pyspark/sql/readwriter.py b/python/pyspark/sql/readwriter.py
index d120daa..47d5824 100644
--- a/python/pyspark/sql/readwriter.py
+++ b/python/pyspark/sql/readwriter.py
@@ -1196,7 +1196,8 @@ class DataFrameWriter(OptionUtils):
encoding : str, optional
specifies encoding (charset) of saved json files. If None is set,
the default UTF-8 charset will be used.
- lineSep : str, optional defines the line separator that should be used
for writing. If None is
+ lineSep : str, optional
+ defines the line separator that should be used for writing. If
None is
set, it uses the default value, ``\\n``.
ignoreNullFields : str or bool, optional
Whether to ignore null fields when generating JSON objects.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
![https://user-images.githubusercontent.com/8269566/114631408-5c608900-9c71-11eb-8ded-ae1e21ae48b2.png"](https://user-images.githubusercontent.com/8269566/114631408-5c608900-9c71-11eb-8ded-ae1e21ae48b2.png"){kind=link}