Flink: Improve ConfigOption Descriptions for Flink Table Maintenance Configs. #13832
+223
−20
Conversation
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
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.
This pull request improves the readability and maintainability of the following configuration classes by enhancing the descriptions for ConfigOptions and adding necessary comments:
Added clear descriptions for configuration options such as
LOCK_CHECK_DELAY_OPTION,PARALLELISM_OPTION,RATE_LIMIT_OPTION, andSLOT_SHARING_GROUP_OPTION.Added comments explaining the purpose and function of each configuration option.
Added detailed descriptions for configuration options like
LOCK_TYPE_OPTION,LOCK_ID_OPTION,JdbcLockConfig, andZkLockConfigrelated to different locking mechanisms.Improved code clarity by explaining the role of each configuration option for locking (e.g.,
JDBC_URI_OPTION,ZK_URI_OPTION, etc.).Enhanced the descriptions of configuration options, including
MAX_BYTES_OPTION,PARTIAL_PROGRESS_MAX_COMMITS_OPTION,SCHEDULE_ON_COMMIT_COUNT_OPTION,SCHEDULE_ON_DATA_FILE_COUNT_OPTION, and more.Added helpful comments to clarify the purpose of each configuration setting related to data rewriting and its usage in Flink-based maintenance tasks.