Skip to content

[core] Fix stale default value in sort-compaction.range-strategy description - #9104

Open
jackylee-ch wants to merge 1 commit into
apache:masterfrom
jackylee-ch:core-range-strategy-default-doc
Open

[core] Fix stale default value in sort-compaction.range-strategy description#9104
jackylee-ch wants to merge 1 commit into
apache:masterfrom
jackylee-ch:core-range-strategy-default-doc

Conversation

@jackylee-ch

Copy link
Copy Markdown
Contributor

Purpose

sort-compaction.range-strategy describes itself as "the default value is quantity", but
#6826 changed defaultValue to RangeStrategy.SIZE. The generated docs render both, so the
Default column says SIZE while the description says quantity.

Reworded the description to match, and rewrote the second sentence which described the old
default as the opt-in. Regenerated core_configuration.html.

Tests

ConfigOptionsDocsCompletenessITCase — passes; fails if the generated html is left stale.

…ription

The description still said the default is quantity, but apache#6826 changed
defaultValue to RangeStrategy.SIZE. Regenerated core_configuration.html.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant