This is an automated email from the ASF dual-hosted git repository.
gurwls223 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 62cdc564d5b3 [SPARK-49532][DOCS][PS] Improve documentation of
"plotting.sample_ratio" option
62cdc564d5b3 is described below
commit 62cdc564d5b3cf7684f0e95e9b31691019c9035f
Author: Xinrong Meng <[email protected]>
AuthorDate: Fri Sep 6 20:30:16 2024 +0900
[SPARK-49532][DOCS][PS] Improve documentation of "plotting.sample_ratio"
option
### What changes were proposed in this pull request?
The current documentation incorrectly suggests that "plotting.sample_ratio"
**defaults** to "plotting.max_rows". In reality, if "plotting.sample_ratio" is
not explicitly set, it is **derived** based on the ratio of "plotting.max_rows"
to the dataset size.
### Why are the changes needed?
To avoid misunderstandings about how these options interact.
### Does this PR introduce _any_ user-facing change?
Doc change only.
### How was this patch tested?
Existing tests.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #48013 from xinrong-meng/doc_impr.
Authored-by: Xinrong Meng <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
---
python/pyspark/pandas/config.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/python/pyspark/pandas/config.py b/python/pyspark/pandas/config.py
index bfa88253dc6f..6ed4adf21ff4 100644
--- a/python/pyspark/pandas/config.py
+++ b/python/pyspark/pandas/config.py
@@ -287,7 +287,8 @@ _options: List[Option] = [
doc=(
"'plotting.sample_ratio' sets the proportion of data that will be
plotted for sample-"
"based plots such as `plot.line` and `plot.area`. "
- "This option defaults to 'plotting.max_rows' option."
+ "If not set, it is derived from 'plotting.max_rows', by
calculating the ratio of "
+ "'plotting.max_rows' to the total data size."
),
default=None,
types=(float, type(None)),
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
