This is an automated email from the ASF dual-hosted git repository.
uros-b 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 ccf0eb5162e0 [MINOR][DOC] Fix grammar in
spark.speculation.efficiency.processRateMultiplier doc
ccf0eb5162e0 is described below
commit ccf0eb5162e0cd3aee480036969361ac3be55b21
Author: Uros Bojanic <[email protected]>
AuthorDate: Sun Jul 26 22:21:45 2026 +0000
[MINOR][DOC] Fix grammar in
spark.speculation.efficiency.processRateMultiplier doc
### What changes were proposed in this pull request?
Fixes the grammar of the
`spark.speculation.efficiency.processRateMultiplier` description: "A multiplier
that used when evaluating inefficient tasks" becomes "A multiplier that is used
...". The fix is applied in both the config's `.doc()` string
(`core/.../config/package.scala`) and the mirrored `docs/configuration.md`
entry so they stay in sync.
### Why are the changes needed?
The relative clause was missing its verb. Both the source `.doc()` and the
generated docs table had the same defect.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Docs/description-string change; no behavior change. No tests needed.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Opus 4.8)
Closes #57543 from uros-b/doc-config-processratemultiplier-grammar.
Lead-authored-by: Uros Bojanic <[email protected]>
Co-authored-by: Uros Bojanic <[email protected]>
Signed-off-by: Uros Bojanic <[email protected]>
---
core/src/main/scala/org/apache/spark/internal/config/package.scala | 4 ++--
docs/configuration.md | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/core/src/main/scala/org/apache/spark/internal/config/package.scala
b/core/src/main/scala/org/apache/spark/internal/config/package.scala
index 9ddb0a025ab7..c04e8943ff37 100644
--- a/core/src/main/scala/org/apache/spark/internal/config/package.scala
+++ b/core/src/main/scala/org/apache/spark/internal/config/package.scala
@@ -2587,8 +2587,8 @@ package object config {
private[spark] val SPECULATION_EFFICIENCY_TASK_PROCESS_RATE_MULTIPLIER =
ConfigBuilder("spark.speculation.efficiency.processRateMultiplier")
- .doc("A multiplier that used when evaluating inefficient tasks. The
higher the multiplier " +
- "is, the more tasks will be possibly considered as inefficient.")
+ .doc("A multiplier that is used when evaluating inefficient tasks. The
higher the " +
+ "multiplier is, the more tasks will be possibly considered as
inefficient.")
.version("3.4.0")
.doubleConf
.checkValue(v => v > 0.0 && v <= 1.0, "multiplier must be in (0.0, 1.0]")
diff --git a/docs/configuration.md b/docs/configuration.md
index ba66aba66128..38460273a823 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -3144,7 +3144,7 @@ Apart from these, the following properties are also
available, and may be useful
<td><code>spark.speculation.efficiency.processRateMultiplier</code></td>
<td>0.75</td>
<td>
- A multiplier that used when evaluating inefficient tasks. The higher the
multiplier
+ A multiplier that is used when evaluating inefficient tasks. The higher
the multiplier
is, the more tasks will be possibly considered as inefficient.
</td>
<td>3.4.0</td>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
