docs: fix several typos in the document #22066
Conversation
fix several typos in the document
📝 Walkthrough📝 WalkthroughWalkthroughThe changes in this pull request primarily involve textual modifications to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
|
julienrbrt
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
🧹 Outside diff range and nitpick comments (1)
docs/architecture/PROCESS.md (1)
49-49: Approved with suggestion: Grammar improvement and clarity enhancementThe change from "Clear notify" to "Clear notification" improves the grammar and clarity of the sentence. However, to further enhance readability, consider rephrasing the beginning of the sentence:
- * `LAST CALL <date for the last call>`: [optional] Clear notification that we are close to accepting updates. + * `LAST CALL <date for the last call>`: [optional] Provides clear notification that we are close to accepting updates.This adjustment makes the sentence structure more consistent with the other bullet points in the list.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: Loose punctuation mark.
Context: .... *LAST CALL <date for the last call>: [optional] Clear notify that we are clo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Cosmos SDK maintainers) has been reached and we still want to give it a time to let ...(COMMA_COMPOUND_SENTENCE)
[style] ~49-~49: Consider replacing ‘give’ with a different word to let your writing stand out.
Context: ...) has been reached and we still want to give it a time to let the community react or an...(GIVE_TIME_STYLE)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/architecture/PROCESS.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/PROCESS.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/PROCESS.md
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ... ABANDONED ``` *DRAFT: [optional] an ADR which is a work in pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ... a Draft Pull Request form. *PROPOSED: an ADR covering a full solution archite...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: .... *LAST CALL <date for the last call>: [optional] Clear notify that we are clo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Cosmos SDK maintainers) has been reached and we still want to give it a time to let ...(COMMA_COMPOUND_SENTENCE)
[style] ~49-~49: Consider replacing ‘give’ with a different word to let your writing stand out.
Context: ...) has been reached and we still want to give it a time to let the community react or an...(GIVE_TIME_STYLE)
🔇 Additional comments (4)
docs/architecture/PROCESS.md (4)
4-4: Approved: Grammar improvementThe removal of the article "an" before "early feedback" improves the grammar and makes the phrase more idiomatic. This change enhances the clarity of the documentation.
5-5: Approved: Corrected subject-verb agreementThe change from "is" to "are" correctly addresses the subject-verb agreement. "Context and solution" is a plural subject, so "are" is the appropriate verb form. This improvement enhances the grammatical accuracy of the documentation.
17-17: No visible changes detectedThere are no apparent changes in this line. The mentioned alteration from "consensus has been met" to "consensus has been met" is not visible in the provided diff. This could be due to an error in the AI summary or a change that was subsequently reverted.
48-48: Approved: Improved phrase clarityThe change from "haven't reached an agreed yet" to "haven't reached an agreement yet" is a grammatical improvement. It correctly uses the noun "agreement" instead of the adjective "agreed", making the sentence more clear and grammatically correct.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ... a Draft Pull Request form. *PROPOSED: an ADR covering a full solution archite...(UNLIKELY_OPENING_PUNCTUATION)
julienrbrt
added
the
backport/v0.52.x
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/architecture/PROCESS.md (1)
48-49: Grammatical improvements approved with a minor suggestionThe changes on these lines significantly improve grammar and clarity:
- Line 48: "reached an agreement" is the correct phrase, replacing the incorrect "reached an agreed".
- Line 49: Removing "clear" before "Notify" improves conciseness.
These changes are approved. However, I have a minor suggestion to further improve clarity:
Consider adding a comma after "reached" on line 49 to separate the two independent clauses:
- * `LAST CALL <date for the last call>`: [optional] Notify that we are close to accepting updates. Changing a status to `LAST CALL` means that social consensus (of Cosmos SDK maintainers) has been reached and we still want to give it a time to let the community react or analyze. + * `LAST CALL <date for the last call>`: [optional] Notify that we are close to accepting updates. Changing a status to `LAST CALL` means that social consensus (of Cosmos SDK maintainers) has been reached, and we still want to give it time to let the community react or analyze.This change would improve readability and adhere to the comma usage rule for compound sentences.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ... a Draft Pull Request form. *PROPOSED: an ADR covering a full solution archite...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: .... *LAST CALL <date for the last call>: [optional] Notify that we are close to ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Cosmos SDK maintainers) has been reached and we still want to give it a time to let ...(COMMA_COMPOUND_SENTENCE)
[style] ~49-~49: Consider replacing ‘give’ with a different word to let your writing stand out.
Context: ...) has been reached and we still want to give it a time to let the community react or an...(GIVE_TIME_STYLE)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
- docs/architecture/PROCESS.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/PROCESS.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/PROCESS.md
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ... ABANDONED ``` *DRAFT: [optional] an ADR which is a work in pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ... a Draft Pull Request form. *PROPOSED: an ADR covering a full solution archite...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: .... *LAST CALL <date for the last call>: [optional] Notify that we are close to ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Cosmos SDK maintainers) has been reached and we still want to give it a time to let ...(COMMA_COMPOUND_SENTENCE)
[style] ~49-~49: Consider replacing ‘give’ with a different word to let your writing stand out.
Context: ...) has been reached and we still want to give it a time to let the community react or an...(GIVE_TIME_STYLE)
🔇 Additional comments (2)
docs/architecture/PROCESS.md (2)
4-4: Grammatical improvement approvedThe removal of "an" before "early feedback" is correct. "Feedback" is an uncountable noun and doesn't require an article in this context.
5-5: Subject-verb agreement correction approvedThe change from "is" to "are" correctly addresses the subject-verb agreement. Since "context and solution" is a plural subject, "are" is the appropriate verb form.
Co-authored-by: Julien Robert <julien@rbrt.fr> (cherry picked from commit 947ffe0)
fix several typos in the document
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
PROCESS.mddocument through grammatical adjustments and refined descriptions.