[SPARK-49765][DOCS][PYTHON] Adjust documentation of "spark.sql.pyspar…

…k.plotting.max_rows" ### What changes were proposed in this pull request? Adjust documentation of "spark.sql.pyspark.plotting.max_rows". ### Why are the changes needed? Adjust for apache#48218, which eliminates the need for the "spark.sql.pyspark.plotting.sample_ratio" config. ### 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 apache#48221 from xinrong-meng/conf_doc. Authored-by: Xinrong Meng <[email protected]> Signed-off-by: Hyukjin Kwon <[email protected]>
sluk3r · Sep 25, 2024 · 5134c68 · 5134c68
1 parent 9aa11d1
commit 5134c68
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala
@@ -3171,9 +3171,9 @@ object SQLConf {
 
   val PYSPARK_PLOT_MAX_ROWS =
     buildConf("spark.sql.pyspark.plotting.max_rows")
-      .doc(
-        "The visual limit on top-n-based plots. If set to 1000, the first 1000 data points " +
-        "will be used for plotting.")
+      .doc("The visual limit on plots. If set to 1000 for top-n-based plots (pie, bar, barh), " +
+        "the first 1000 data points will be used for plotting. For sampled-based plots " +
+        "(scatter, area, line), 1000 data points will be randomly sampled.")
       .version("4.0.0")
       .intConf
       .createWithDefault(1000)