Skip to content

[MINOR][DOCS][SQL] Fix doc comment for coalescePartitions.parallelismFirst#45437

Closed
eejbyfeldt wants to merge 1 commit intoapache:masterfrom
eejbyfeldt:fix-minor-doc-comment-on-parallism-first
Closed

[MINOR][DOCS][SQL] Fix doc comment for coalescePartitions.parallelismFirst#45437
eejbyfeldt wants to merge 1 commit intoapache:masterfrom
eejbyfeldt:fix-minor-doc-comment-on-parallism-first

Conversation

@eejbyfeldt
Copy link
Contributor

@eejbyfeldt eejbyfeldt commented Mar 8, 2024

This changes the second true to false to make the doc comment correct. A setting of false will mean to not prioritize parallism and that will lead to less small tasks. Seems like it incorrectness was introduced here: #44787

What changes were proposed in this pull request?

Documentation fix.

Why are the changes needed?

Current doc is wrong.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

N/A

Was this patch authored or co-authored using generative AI tooling?

No.

This changes the second `true` to `false` to make the doc comment
correct. A setting of false will mean to not prioritize parallism and
that will leak less small tasks.
"configured target size. This is to maximize the parallelism and avoid performance " +
"regressions when enabling adaptive query execution. It's recommended to set this " +
"config to true on a busy cluster to make resource utilization more efficient (not many " +
"config to false on a busy cluster to make resource utilization more efficient (not many " +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch! It's recommended to flip the default value, so "false"

@HyukjinKwon
Copy link
Member

HyukjinKwon commented Mar 11, 2024

Merged to master.

@eejbyfeldt
Copy link
Contributor Author

Realised that this doc comment is actually in 2 places: #45458

yaooqinn pushed a commit that referenced this pull request Mar 11, 2024
…First on sql-performance-tuning page

We missed that this doc comment is duplicated while fixing it in #45437

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

Documentation fix.

### Why are the changes needed?

Current doc is wrong.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

N/A

### Was this patch authored or co-authored using generative AI tooling?

No.

Closes #45458 from eejbyfeldt/fix-minor-doc-comment-on-parallism-first.

Authored-by: Emil Ejbyfeldt <eejbyfeldt@liveintent.com>
Signed-off-by: Kent Yao <yao@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants