chore: fix some comments #1517
chore: fix some comments #1517
Conversation
pudongair
requested review from
yihuang and
mmsqe
and removed request for
a team
WalkthroughThe recent changes include a significant update to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Cronos
participant IBC
User->>Cronos: Send tokens
Cronos->>IBC: Transfer tokens with channelId
IBC-->>Cronos: Confirmation of transfer
Cronos-->>User: Tokens sent successfully
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/architecture/adr-007.md (1)
40-40: Fix unordered list style.The list item should use an asterisk instead of a dash.
- - Event `__CronosSendToIbc` has different signature in CRC20 and CR21. + * Event `__CronosSendToIbc` has different signature in CRC20 and CR21.Tools
Markdownlint
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
docs/gravity-bridge/dev-setup-guide.md (1)
168-168: Correct the grammar.Change "setup" to "set up" to use the correct past participle form.
- the gravity bridge between ethereum and cronos is setup successfully. + the gravity bridge between ethereum and cronos is set up successfully.Tools
LanguageTool
[grammar] ~168-~168: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...y bridge between ethereum and cronos is setup successfully.(BE_VB_OR_NN)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- docs/architecture/adr-007.md (1 hunks)
- docs/gravity-bridge/dev-setup-guide.md (1 hunks)
- integration_tests/test_basic.py (2 hunks)
- integration_tests/test_replay_block.py (1 hunks)
- memiavl/README.md (1 hunks)
- memiavl/multitree.go (1 hunks)
Files skipped from review due to trivial changes (4)
- integration_tests/test_basic.py
- integration_tests/test_replay_block.py
- memiavl/README.md
- memiavl/multitree.go
Additional context used
Markdownlint
docs/architecture/adr-007.md
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
LanguageTool
docs/gravity-bridge/dev-setup-guide.md
[grammar] ~168-~168: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...y bridge between ethereum and cronos is setup successfully.(BE_VB_OR_NN)
|
can you sign the commit @pudongair |
Signed-off-by: pudongair <[email protected]>
Signed~ Please review again. |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/architecture/adr-007.md (1)
40-40: Use asterisks for unordered list items.The markdown linting tool suggests using an asterisk instead of a dash for unordered list items.
- - Event `__CronosSendToIbc` has different signature in CRC20 and CR21. + * Event `__CronosSendToIbc` has different signature in CRC20 and CR21.Tools
Markdownlint
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
docs/gravity-bridge/dev-setup-guide.md (1)
168-168: Use "set up" instead of "setup".The LanguageTool suggests using "set up" instead of "setup" to correct the grammatical issue.
- After all the orchestrator processes run, the gravity bridge between ethereum and cronos is setup successfully. + After all the orchestrator processes run, the gravity bridge between ethereum and cronos is set up successfully.Tools
LanguageTool
[grammar] ~168-~168: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...y bridge between ethereum and cronos is setup successfully.(BE_VB_OR_NN)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- docs/architecture/adr-007.md (1 hunks)
- docs/gravity-bridge/dev-setup-guide.md (1 hunks)
- integration_tests/test_basic.py (2 hunks)
- integration_tests/test_replay_block.py (1 hunks)
- memiavl/README.md (1 hunks)
- memiavl/multitree.go (1 hunks)
Files skipped from review due to trivial changes (3)
- integration_tests/test_basic.py
- integration_tests/test_replay_block.py
- memiavl/multitree.go
Files skipped from review as they are similar to previous changes (1)
- memiavl/README.md
Additional context used
Markdownlint
docs/architecture/adr-007.md
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
LanguageTool
docs/gravity-bridge/dev-setup-guide.md
[grammar] ~168-~168: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...y bridge between ethereum and cronos is setup successfully.(BE_VB_OR_NN)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1517 +/- ##
=======================================
Coverage 36.84% 36.84%
=======================================
Files 117 117
Lines 8124 8124
=======================================
Hits 2993 2993
Misses 4766 4766
Partials 365 365
|
901d841
fix some comments
PR Checklist:
make)make test)go fmt)golangci-lint run)go list -json -m all | nancy sleuth)Thank you for your code, it's appreciated! :)
Summary by CodeRabbit
New Features
__CronosSendToIbcevent to include achannelIdargument, enhancing flexibility in token transfers.Bug Fixes
Documentation