docs: Quotation marks are used incorrectly.

[RiceChuan]

Quotation marks are used incorrectly.

Summary by CodeRabbit

• Documentation
  • Updated architecture decision records (ADRs) for Protobuf Msg Services and inter-module communication, enhancing clarity and compliance.
  • Minor textual modifications in the ADR for arbitrary signatures to improve readability.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request involves updates to three architecture decision records (ADRs) in the documentation. The changes primarily focus on refining Protobuf-related specifications, including syntax corrections, inter-module communication mechanisms, and signature handling. The modifications aim to improve the clarity, security, and functionality of module interactions within the Cosmos SDK ecosystem, with a particular emphasis on Protobuf service definitions and module authorization.

Changes

File	Change Summary
docs/architecture/adr-031-msg-service.md	Minor syntax correction for Protobuf option in MsgSubmitProposal message
docs/architecture/adr-033-protobuf-inter-module-comm.md	- Added new types: ModuleKey and ModuleID - Introduced new methods for module key derivation and invocation - Updated Configurator interface with additional methods
docs/architecture/adr-036-arbitrary-signature.md	Formatting and quotation mark adjustments, with no substantive content changes

Possibly related PRs

• docs: fixed typo in threshold and quorums section of onchain multi-sig guide in user guide section of sdk docs #22374: Typo fix in threshold and quorum documentation
• docs: Update protobuf tx signing message format outer link #22510: Update of Protobuf transaction encoding documentation link
• docs: update links for https security protocol #22514: HTTPS security protocol link updates
• docs: fix typos in various documentation files #22722: Protobuf-related documentation typographical corrections
• chore(docs): fix incorrect usage of 'a' and 'an' across documentation #22976: Grammatical error fixes in documentation
• docs: fix spelling errors #23038: Spelling error corrections
• docs: remove redundant words and symbols #23058: Removal of redundant words and symbols
• docs: fix typos in documentation files #23063: Documentation typo fixes

Suggested reviewers

• sontrinh16
• julienrbrt
• akhilkumarpilli

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2f8d and 8a471bf.

📒 Files selected for processing (3)

• docs/architecture/adr-031-msg-service.md (1 hunks)
• docs/architecture/adr-033-protobuf-inter-module-comm.md (1 hunks)
• docs/architecture/adr-036-arbitrary-signature.md (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/architecture/adr-036-arbitrary-signature.md

🧰 Additional context used

📓 Path-based instructions (2)

docs/architecture/adr-031-msg-service.md (1)

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

docs/architecture/adr-033-protobuf-inter-module-comm.md (1)

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

🔇 Additional comments (2)

docs/architecture/adr-031-msg-service.md (1)

29-29: LGTM! Correct quotation marks for Protobuf syntax.

The change from curly quotes to straight quotes is correct. Protobuf syntax requires straight quotes (") for string literals, and this fix ensures the code example follows the proper syntax.

docs/architecture/adr-033-protobuf-inter-module-comm.md (1)

46-46: LGTM! Correct quotation marks in code example.

The change from curly quotes to straight quotes is appropriate for code examples. This maintains consistency and ensures readers can copy-paste the example without syntax issues.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.