chore: fix the note box syntax error #20499

suiyuan1314 · 2024-05-31T07:49:55Z

Description

fixed two syntaxes to make the blocks show as expected.

Summary by CodeRabbit

Documentation
- Updated note syntax in docs/README.md for improved readability.
- Corrected formatting of a tip block in protocolpool module documentation.

coderabbitai · 2024-05-31T07:50:10Z

Walkthrough

The changes primarily involve updates to the documentation formatting in two README.md files. Specifically, the docs/README.md file was updated to use :::note syntax instead of ::note, and the x/protocolpool/README.md file had a correction to the closing tag of a tip block. These changes do not affect the functionality or the declarations of exported or public entities.

Changes

Files	Change Summary
docs/README.md	Updated note syntax from `::note` to `:::note`.
x/protocolpool/README.md	Corrected the formatting of the closing tag for a tip block.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (3)

x/protocolpool/README.md (3)
Line range hint 152-155: Standardize the list item markers to use asterisks instead of dashes for consistency.
- - The msg will fail if the amount cannot be transferred from the sender to the protocolpool module account.
+ * The msg will fail if the amount cannot be transferred from the sender to the protocolpool module account.
Also applies to: 171-173, 193-194

Line range hint 61-61: Remove the trailing space to adhere to Markdown best practices.
- It's the responsibility of users to actively claim their allocated funds based on the terms of the approved budget proposals. 
+ It's the responsibility of users to actively claim their allocated funds based on the terms of the approved budget proposals.
Line range hint 95-95: Replace hard tabs with spaces to maintain consistency in indentation.
-	// CreateContinuousFund defines a method to add funds continuously.
+    // CreateContinuousFund defines a method to add funds continuously.
-	// CancelContinuousFund defines a method for cancelling continuous fund.
+    // CancelContinuousFund defines a method for cancelling continuous fund.
Also applies to: 114-114

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 46d6406 and c6b7a0e.

Files selected for processing (2)

docs/README.md (1 hunks)
x/protocolpool/README.md (1 hunks)

Files skipped from review due to trivial changes (1)

docs/README.md

Additional context used

Path-based instructions (1)

x/protocolpool/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Markdownlint

x/protocolpool/README.md

152-152: Expected: asterisk; Actual: dash
Unordered list style

153-153: Expected: asterisk; Actual: dash
Unordered list style

154-154: Expected: asterisk; Actual: dash
Unordered list style

155-155: Expected: asterisk; Actual: dash
Unordered list style

171-171: Expected: asterisk; Actual: dash
Unordered list style

172-172: Expected: asterisk; Actual: dash
Unordered list style

173-173: Expected: asterisk; Actual: dash
Unordered list style

193-193: Expected: asterisk; Actual: dash
Unordered list style

194-194: Expected: asterisk; Actual: dash
Unordered list style

61-61: Expected: 0 or 2; Actual: 1
Trailing spaces

95-95: Column: 1
Hard tabs

114-114: Column: 1
Hard tabs

Additional comments not posted (1)

x/protocolpool/README.md (1)

85-85: Fix the closing tag for the tip block to ensure it displays correctly.

julienrbrt

Thanks!

julienrbrt

Thanks!

* main: (120 commits) chore: update protoc-gen-swagger to protoc-gen-openapiv2 (#20448) ci: Add GitHub Action for go mod tidy and mocks (#20501) chore: Address linter issues (#20486) fix: wrap errors in auto CLI service registration (#20493) chore: fix comment (#20498) chore: fix the note box syntax error (#20499) feat(server/v2): introduce cometbft v2 (#20483) refactor(x/upgrade): migrate to appmodule.VersionMap (#20485) docs: code guidelines changes (#20482) feat(cosmovisor): load cosmovisor configuration from toml file (#19995) perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034) fix: Bump CometBFT versions (#20481) refactor(core): remove redundant ExecMode (#20322) feat(store/v2): pruning manager (#20430) chore: force reload sonar cloud (#20480) refactor(x/accounts): reuse calculated sum in `func safeAdd` (#20458) refactor: remove `defer` in loop (#20223) ci: remove livness test (#20474) build(deps): Bump bufbuild/buf-setup-action from 1.32.1 to 1.32.2 (#20477) chore: migrate a few diagrams to mermaid (#20473) ...

fix the note box syntax error

c6b7a0e

suiyuan1314 requested a review from a team as a code owner May 31, 2024 07:49

github-actions bot added the C:x/protocolpool label May 31, 2024

coderabbitai bot reviewed May 31, 2024

View reviewed changes

julienrbrt approved these changes May 31, 2024

View reviewed changes

sontrinh16 approved these changes May 31, 2024

View reviewed changes

sontrinh16 enabled auto-merge May 31, 2024 08:14

sontrinh16 added this pull request to the merge queue May 31, 2024

Merged via the queue into cosmos:main with commit fa371f5 May 31, 2024
60 of 61 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: fix the note box syntax error #20499

chore: fix the note box syntax error #20499

suiyuan1314 commented May 31, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 31, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

julienrbrt left a comment

julienrbrt left a comment

chore: fix the note box syntax error #20499

chore: fix the note box syntax error #20499

Conversation

suiyuan1314 commented May 31, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

coderabbitai bot commented May 31, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

suiyuan1314 commented May 31, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 31, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)