docs: remove duplicate sentence in RFC 003 #23506
Conversation
📝 WalkthroughWalkthroughThe pull request updates the RFC-003 document by enhancing the "Background" section to provide a clearer description of the key target user groups for the Cosmos SDK. It distinguishes between two user groups: one focusing on projects that target a single programming language and another on those integrating multiple languages and environments. Additionally, a typographical error in the "State and Volatility" section is corrected. The overall structure of the document remains unchanged. Changes
Suggested Reviewers
Possibly related PRs
Suggested labels
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
Documentation and Community
|
wonderfan
changed the title
wonderfan
changed the title
![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
🧹 Nitpick comments (1)
docs/rfc/rfc-003-crosslang.md (1)
173-173: Add blank lines around the list for better formatting.To improve markdown formatting and readability, add blank lines before and after the bullet point list.
Apply this formatting change:
**Volatility** describes a message handler's behavior with respect to state and side effects. It is an enum value that can have one of the following values: + * `volatile`: the handler can have side effects and send `volatile`, `readonly` or `pure` messages to other accounts. Such handlers are expected to both read and write state. * `readonly`: the handler cannot cause effects side effects and can only send `readonly` or `pure` messages to other accounts. Such handlers are expected to only read state. * `pure`: the handler cannot cause any side effects and can only call other pure handlers. Such handlers are expected to neither read nor write state. + The hypervisor will enforce **volatility** rules when routing messages to account handlers.🧰 Tools
🪛 Markdownlint (0.37.0)
173-173: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/rfc/rfc-003-crosslang.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/rfc/rfc-003-crosslang.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 Markdownlint (0.37.0)
docs/rfc/rfc-003-crosslang.md
173-173: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: repo-analysis
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: dependency-review
- GitHub Check: Summary
🔇 Additional comments (2)
docs/rfc/rfc-003-crosslang.md (2)
12-12: LGTM! Improved document readability.The removal of the duplicate sentence "Recently we have identified the following key target user groups:" enhances the document's clarity while maintaining the intended meaning.
173-173: LGTM! Correct terminology used.The description of the
volatilehandler type is accurate and consistent with the overall volatility model described in this section.🧰 Tools
🪛 Markdownlint (0.37.0)
173-173: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
The sentence "Recently we have identified the following key target user groups:" was accidentally repeated. This commit removes the duplicate to improve readability.
It should be readonly instead of "radonly"
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/rfc/rfc-003-crosslang.md (1)
173-175: Add blank lines around the list for better readability.Following markdown best practices, lists should be surrounded by blank lines to improve readability and ensure consistent rendering across different markdown processors.
Apply this formatting change:
**Volatility** describes a message handler's behavior with respect to state and side effects. It is an enum value that can have one of the following values: + * `volatile`: the handler can have side effects and send `volatile`, `readonly` or `pure` messages to other accounts. Such handlers are expected to both read and write state. * `readonly`: the handler cannot cause effects side effects and can only send `readonly` or `pure` messages to other accounts. Such handlers are expected to only read state. * `pure`: the handler cannot cause any side effects and can only call other pure handlers. Such handlers are expected to neither read nor write state. + The hypervisor will enforce **volatility** rules when routing messages to account handlers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~174-~174: Loose punctuation mark.
Context: ... both read and write state. *readonly: the handler cannot cause effects side e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...re expected to only read state. *pure: the handler cannot cause any side effec...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
173-173: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/rfc/rfc-003-crosslang.md(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/rfc/rfc-003-crosslang.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 Markdownlint (0.37.0)
docs/rfc/rfc-003-crosslang.md
173-173: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: tests (03)
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: dependency-review
- GitHub Check: Summary
🔇 Additional comments (1)
docs/rfc/rfc-003-crosslang.md (1)
12-12: LGTM! Improved document readability.The removal of the duplicate sentence "Recently we have identified the following key target user groups:" enhances the document's clarity while maintaining its meaning.
The sentence "Recently we have identified the following key target user groups:" was accidentally repeated. This commit removes the duplicate to improve readability.
Description
Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit