Skip to content
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

docs: fixed typo in threshold and quorums section of onchain multi-sig guide in user guide section of sdk docs #22374

Merged
merged 1 commit into from
Oct 26, 2024

Conversation

pratikpatil2001
Copy link
Contributor

@pratikpatil2001 pratikpatil2001 commented Oct 26, 2024

Screenshot from 2024-10-25 10-27-15

@pratikpatil2001 pratikpatil2001 requested a review from a team as a code owner October 26, 2024 12:06
Copy link
Contributor

coderabbitai bot commented Oct 26, 2024

📝 Walkthrough

Walkthrough

The document 08-onchain-multisig.md has been updated to improve the clarity and completeness of on-chain multisignature transaction explanations. Key modifications include corrections to typographical errors, elaboration on voting mechanics, and the introduction of new sections detailing the voting period and proposal creation process. The setup instructions have been refined, and examples provided to facilitate user understanding of the new multisig implementation.

Changes

File Change Summary
docs/user/run-node/08-onchain-multisig.md Enhanced explanations of on-chain multisig transactions, including corrections, new sections, and examples for clarity.

Possibly related PRs

Suggested labels

Type: ADR

Suggested reviewers

  • sontrinh16
  • julienrbrt
  • tac0turtle

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@pratikpatil2001 pratikpatil2001 changed the title fixed typo in threshold and quorums section of onchain multi-sig guide fixed typo in threshold and quorums section of onchain multi-sig guide in user guide section of sdk docs Oct 26, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
docs/user/run-node/08-onchain-multisig.md (1)

17-17: Approve the typo fix with a minor suggestion for clarity.

The correction improves the explanation of threshold vs quorum. To make it even clearer, consider adding an example:

-threshold is the minimum of voting power of YES votes to pass a proposal.
+threshold is the minimum voting power of YES votes required to pass a proposal. For example, with 3 members having 1000 weight each and a threshold of 2000, at least 2 members must vote YES for the proposal to pass.
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cf419e1 and d7c6fb8.

📒 Files selected for processing (1)
  • docs/user/run-node/08-onchain-multisig.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/user/run-node/08-onchain-multisig.md (1)

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

@pratikpatil2001 pratikpatil2001 changed the title fixed typo in threshold and quorums section of onchain multi-sig guide in user guide section of sdk docs docs: fixed typo in threshold and quorums section of onchain multi-sig guide in user guide section of sdk docs Oct 26, 2024
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 26, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Oct 26, 2024
Merged via the queue into cosmos:main with commit 51d8acf Oct 26, 2024
75 of 88 checks passed
mergify bot pushed a commit that referenced this pull request Oct 26, 2024
…g guide in user guide section of sdk docs (#22374)

(cherry picked from commit 51d8acf)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants