chore: Improve wording of error message #17766
Merged
Conversation
This file contains 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
WanYixian
changed the title
github-actions
bot
added
type/chore
Invalid PR Title
and removed
Invalid PR Title
labels
ShanlanLi
approved these changes
Jul 24, 2024
| @@ -7,7 +7,7 @@ create source s ( | |||
| properties.bootstrap.server = 'message_queue:29092' | |||
| ) ROW FORMAT JSON; | |||
|
|
|||
| statement error properties `scan_startup_mode` only support earliest and latest or leave it empty | |||
| statement error properties `scan_startup_mode` only supports earliest and latest or leaving it empty | |||
There was a problem hiding this comment.
Suggested change
| statement error properties `scan_startup_mode` only supports earliest and latest or leaving it empty | |
| statement error property `scan_startup_mode` only accepts three options: earliest, latest, or left empty |
| @@ -403,8 +403,8 @@ impl<S: StateStore, const USE_WATERMARK_CACHE: bool> DynamicFilterExecutor<S, US | |||
| let (range, _latest_is_lower, is_insert) = self.get_range(&curr, prev); | |||
|
|
|||
| if !is_insert && self.condition_always_relax { | |||
| bail!("The optimizer inferred that the right side's change always make the condition more relaxed.\ | |||
| But the right changes make the conditions stricter."); | |||
| bail!("The optimizer incorrectly assumed that changes on the right side always relax the condition.\ | |||
There was a problem hiding this comment.
It's a bit hard to understand this message.
stdrc
reviewed
Jul 26, 2024
There was a problem hiding this comment.
Added some change suggestions, including the following several aspects:
- Names (of columns, keys, schemas, tables, etc.) should be in
`inline code. - Proper noun should be in proper form, e.g.
Flink,RisingWave,BigQuery.
Another suggestion: Maybe we should prefer passive voice like Column (is) not found, Xxx mode is not supported, Property `xxx` of Xxx is not supported , Xxx required by xxx is not found. In this way, we can emphasize the object that is problematic.
...tor-node/risingwave-sink-cassandra/src/main/java/com/risingwave/connector/CassandraUtil.java
Outdated
Show resolved
Hide resolved
...tor-node/risingwave-sink-cassandra/src/main/java/com/risingwave/connector/CassandraUtil.java
Outdated
Show resolved
Hide resolved
...tor-node/risingwave-sink-cassandra/src/main/java/com/risingwave/connector/CassandraUtil.java
Outdated
Show resolved
Hide resolved
...tor-node/risingwave-sink-cassandra/src/main/java/com/risingwave/connector/CassandraUtil.java
Outdated
Show resolved
Hide resolved
...-sink-mock-flink-common/src/main/java/com/risingwave/mock/flink/common/FlinkDynamicUtil.java
Outdated
Show resolved
Hide resolved
...-sink-mock-flink-common/src/main/java/com/risingwave/mock/flink/common/FlinkDynamicUtil.java
Outdated
Show resolved
Hide resolved
…m/risingwave/connector/CassandraUtil.java Co-authored-by: Richard Chien <[email protected]>
…m/risingwave/connector/CassandraUtil.java Co-authored-by: Richard Chien <[email protected]>
…m/risingwave/connector/CassandraUtil.java Co-authored-by: Richard Chien <[email protected]>
…m/risingwave/connector/CassandraUtil.java Co-authored-by: Richard Chien <[email protected]>
…-mock-flink-common/src/main/java/com/risingwave/mock/flink/common/FlinkDynamicUtil.java Co-authored-by: Richard Chien <[email protected]>
…-mock-flink-common/src/main/java/com/risingwave/mock/flink/common/FlinkDynamicUtil.java Co-authored-by: Richard Chien <[email protected]>
Co-authored-by: Richard Chien <[email protected]>
Co-authored-by: Richard Chien <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
Co-authored-by: Eric Fu <[email protected]>
|
@BugenZhao any other suggestions? |
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.
I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.
What's changed and what's your intention?
According to request, use
bail!.contextanyhowErrString.formatto do a global search of error messages and improve the wording.This is the guidance.
Feel free to check out and see if all changes make sense, thanks!