docs: correct three wrong default values in CoreOptions doc comments - #640
Open
jackylee-ch wants to merge 1 commit into
Open
docs: correct three wrong default values in CoreOptions doc comments#640jackylee-ch wants to merge 1 commit into
jackylee-ch wants to merge 1 commit into
Conversation
Three accessor doc comments state defaults that disagree with the constants right next to them: - `bucket()` says "Default is 1" but `DEFAULT_BUCKET` is `-1`; the existing test asserts `bucket() == -1`, and Java defaults to `-1` as well. - `target_file_size()` says "Default is 128MB" but `DEFAULT_TARGET_FILE_SIZE` is 256 MiB. Java gives `target-file-size` no default and documents 128 MB for primary-key tables and 256 MB for append tables, so record which value this returns. - `dynamic_bucket_target_row_num()` claims 200,000 matches Java, but Java defaults `dynamic-bucket.target-row-num` to 2,000,000. State the difference instead of asserting parity; the constant is left alone. Comments only, no behavior change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three accessor doc comments in
core_options.rsstate defaults that disagree withthe constants right next to them:
bucket()says "Default is 1" butDEFAULT_BUCKETis-1. The existing testasserts
bucket() == -1, and Java defaults to-1too — the comment is theonly thing wrong.
target_file_size()says "Default is 128MB" butDEFAULT_TARGET_FILE_SIZEis256 MiB. Java gives this option no default and documents 128 MB for primary-key
tables / 256 MB for append tables, so the comment now records which one this
returns.
dynamic_bucket_target_row_num()claims 200,000 "matching Java Paimon", butJava defaults
dynamic-bucket.target-row-numto 2,000,000. This states thedifference rather than asserting parity; the constant is left unchanged —
happy to follow up if you want the value aligned instead.
Comments only, no behavior change.