-
Notifications
You must be signed in to change notification settings - Fork 170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Typos fix #2192
Typos fix #2192
Conversation
Signed-off-by: Romashka <[email protected]>
Signed-off-by: Romashka <[email protected]>
Signed-off-by: Romashka <[email protected]>
Signed-off-by: Romashka <[email protected]>
WalkthroughThe pull request includes several minor corrections to comments in various files across the codebase. Specifically, it addresses typographical errors in the comments of the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
📒 Files selected for processing (4)
kurtosis/src/services/blutgang/config.toml.tmpl
(1 hunks)mod/async/pkg/dispatcher/dispatcher.go
(1 hunks)mod/state-transition/pkg/core/errors.go
(1 hunks)mod/state-transition/pkg/core/state_processor_staking_test.go
(1 hunks)
🧰 Additional context used
📓 Learnings (2)
mod/state-transition/pkg/core/errors.go (1)
Learnt from: abi87
PR: berachain/beacon-kit#2115
File: mod/state-transition/pkg/core/state_processor_staking.go:80-80
Timestamp: 2024-11-24T20:29:46.590Z
Learning: When reporting deposit mismatches in error messages, it's unnecessary to include the deposit index separately since it is already present within the deposit data.
mod/state-transition/pkg/core/state_processor_staking_test.go (2)
Learnt from: abi87
PR: berachain/beacon-kit#2142
File: mod/state-transition/pkg/core/state_processor_staking_test.go:154-168
Timestamp: 2024-11-12T11:12:56.774Z
Learning: In the `TestTransitionUpdateValidators` function in `mod/state-transition/pkg/core/state_processor_staking_test.go`, adding additional assertions for balance relationships is not necessary.
Learnt from: abi87
PR: berachain/beacon-kit#2142
File: mod/state-transition/pkg/core/state_processor_staking_test.go:175-197
Timestamp: 2024-11-12T11:12:56.774Z
Learning: In Go test files within the `mod/state-transition/pkg/core/` directory, when a test is already substantial in size, avoid adding verbose code or comments that increase its length further.
🔇 Additional comments (4)
kurtosis/src/services/blutgang/config.toml.tmpl (1)
26-27
:
Inconsistency between comment and config key
While the comment correctly spells "Suppress", the corresponding config key supress_rpc_check
is misspelled (missing a 'p'). This creates an inconsistency that should be addressed.
Let's verify the config key usage in the codebase:
Based on the search results, we can determine whether it's safe to update the config key to match the comment's spelling.
mod/async/pkg/dispatcher/dispatcher.go (1)
33-33
: LGTM! Typo fix is correct.
The spelling correction from "faciliates" to "facilitates" is accurate and improves the documentation quality.
mod/state-transition/pkg/core/errors.go (1)
42-42
: LGTM! Typo fix is correct.
The spelling correction from "corrispondent" to "correspondent" in the error comment is accurate.
mod/state-transition/pkg/core/state_processor_staking_test.go (1)
38-38
: LGTM! Typo fix approved.
The correction of "corrensponding" to "corresponding" improves the comment's readability.
// block is different from the correspondent one from store. | ||
ErrDepositMismatch = errors.New("deposit mismatched") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Consider enhancing the error message based on previous feedback.
Based on previous feedback from PR #2115, consider improving the error message to be more specific about the deposit mismatch without needing to separately include the deposit index, as it's already present in the deposit data.
- ErrDepositMismatch = errors.New("deposit mismatched")
+ ErrDepositMismatch = errors.New("deposit data mismatch between block and store")
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
// block is different from the correspondent one from store. | |
ErrDepositMismatch = errors.New("deposit mismatched") | |
// block is different from the correspondent one from store. | |
ErrDepositMismatch = errors.New("deposit data mismatch between block and store") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
This reverts commit a62f991.
Description:
Fixed errors and inaccuracies in the project's textual materials.
Type of Change:
Fixing errors (typos, grammatical mistakes, etc.)
Testing:
Changes have been reviewed to ensure no new errors were introduced.
Impact:
Improved readability of texts and documentation.
Additional Notes:
Regular text audits are recommended to maintain a high standard of quality.
Summary by CodeRabbit
ErrDepositMismatch
.