Skip to content

Commit

Permalink
[SPARK-49765][DOCS][PYTHON] Adjust documentation of "spark.sql.pyspar…
Browse files Browse the repository at this point in the history
…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 <xinrong@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
  • Loading branch information
xinrong-meng authored and HyukjinKwon committed Sep 25, 2024
1 parent 9aa11d1 commit 5134c68
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 5134c68

Please sign in to comment.