ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[MINOR][CORE][DOCS] Fix inconsistent description of showConsoleProgress

Browse source 
## What changes were proposed in this pull request?

The latest docs http://spark.apache.org/docs/latest/configuration.html contains some description as below:

spark.ui.showConsoleProgress | true | Show the progress bar in the console. The progress bar shows the progress of stages that run for longer than 500ms. If multiple stages run at the same time, multiple progress bars will be displayed on the same line.
-- | -- | --

But the class `org.apache.spark.internal.config.UI` define the config `spark.ui.showConsoleProgress` as below:
```
val UI_SHOW_CONSOLE_PROGRESS = ConfigBuilder("spark.ui.showConsoleProgress")
    .doc("When true, show the progress bar in the console.")
    .booleanConf
    .createWithDefault(false)
```
So I think there are exists some little mistake and lead to confuse reader.

## How was this patch tested?

No need UT.

Closes #25297 from beliefer/inconsistent-desc-showConsoleProgress.

Authored-by: gengjiaan <gengjiaan@360.cn>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
This commit is contained in:
gengjiaan 2019-07-31 12:17:44 +09:00 committed by HyukjinKwon
parent 261e113449
commit dba4375359
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/configuration.md
View file

@ -1062,11 +1062,13 @@ Apart from these, the following properties are also available, and may be useful
</tr>
<tr>
<td><code>spark.ui.showConsoleProgress</code></td>
<td>true</td>
<td>false</td>
<td>
Show the progress bar in the console. The progress bar shows the progress of stages
that run for longer than 500ms. If multiple stages run at the same time, multiple
progress bars will be displayed on the same line.
<br/>
<em>Note:</em> In shell environment, the default value of spark.ui.showConsoleProgress is true.
</td>
</tr>
<tr>