fix(docs/adr): spelling #3704
fix(docs/adr): spelling #3704
Conversation
cratiu222
requested review from
evan-forbes and
ninabarbakadze
and removed request for
a team
WalkthroughWalkthroughThe updates involve multiple architecture decision records (ADRs) addressing enhancements in validator set tracking, state usage reduction, non-interactive defaults handling, and network upgrades. Key changes include new message types ( Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![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, codebase verification and nitpick comments (10)
docs/architecture/adr-005-qgb-reduce-state-usage.md (1)
55-55: Refine the phrase to avoid overuse of intensifiers.Consider replacing "very important" with "important" to make the writing clearer.
- This might be the end goal of the QGB, but it will be very important to build at this stage. + This might be the end goal of the QGB, but it will be important to build at this stage.Tools
LanguageTool
[style] ~55-~55: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...the end goal of the QGB, but it will be very important to build at this stage. Also, if this ...(EN_WEAK_ADJECTIVE)
docs/architecture/adr-002-qgb-valset.md (1)
15-15: Correct the noun usage.The word 'confirm' should be 'confirmations' to match the context.
- Please take a look at it to know how we will be handling the confirms. + Please take a look at it to know how we will be handling the confirmations.Tools
LanguageTool
[style] ~15-~15: To make your writing clearer, consider a more direct alternative.
Context: ...adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handl...(TAKE_A_LOOK)
[grammar] ~15-~15: The word ‘confirm’ is not a noun. Did you mean “confirmations”?
Context: ... it to know how we will be handling the confirms. ## Detailed Design Since the QGB is ...(PREPOSITION_VERB)
docs/architecture/adr-018-network-upgrades.md (6)
51-51: Add a comma for clarity.Consider adding a comma after "two weeks" for better readability.
- If the community wished to push back the upgrade by two weeks there is the possibility that some nodes would not rerun the new binary thus we'd get a split between nodes running the old schedule and nodes running the new schedule. + If the community wished to push back the upgrade by two weeks, there is the possibility that some nodes would not rerun the new binary, thus we'd get a split between nodes running the old schedule and nodes running the new schedule.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
51-51: Refine the phrase for better readability.The word "thus" should be separated from the sentence with a comma.
- ... would not rerun the new binary thus we'd get a split between nodes running the old schedule and nodes running the new schedule. + ... would not rerun the new binary, thus we'd get a split between nodes running the old schedule and nodes running the new schedule.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
51-51: Refine word choice for conciseness.Consider replacing "emergency situations" with a shorter alternative.
- This is expected to be used in testing and in emergency situations only. + This is expected to be used in testing and emergencies only.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
51-51: Add a comma for clarity.Consider adding a comma after "Therefore".
- Therefore we employ a range that nodes will attempt to upgrade and afterwards will continue on normally with the new binary however running the older version. + Therefore, we employ a range that nodes will attempt to upgrade and afterwards will continue on normally with the new binary, however running the older version.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
51-51: Use American English for consistency.Replace "afterwards" with "afterward" to match American English usage.
- ... will attempt to upgrade and afterwards will continue on normally with the new binary however running the older version. + ... will attempt to upgrade and afterward will continue on normally with the new binary however running the older version.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
51-51: Add commas for clarity.Consider adding commas around "however".
- ... will continue on normally with the new binary however running the older version. + ... will continue on normally with the new binary, however, running the older version.Tools
LanguageTool
[typographical] ~51-~51: Consider adding a comma.
Context: ...ed to push back the upgrade by two weeks there is the possibility that some nodes woul...(IF_THERE_COMMA)
[typographical] ~51-~51: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...that some nodes would not rerun the new binary thus we'd get a split between nodes running ...(THUS_SENTENCE)
[style] ~51-~51: ‘emergency situations’ might be wordy. Consider a shorter alternative.
Context: ...s expected to be used in testing and in emergency situations only. Another example to keep in mind i...(EN_WORDINESS_PREMIUM_EMERGENCY_SITUATIONS)
[uncategorized] ~51-~51: Possible missing comma found.
Context: .... If some of the validators are for the change they should have some way to continue p...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ... continue participating in the network. Therefore we employ a range that nodes will attem...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[locale-violation] ~51-~51: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... that nodes will attempt to upgrade and afterwards will continue on normally with the new ...(AFTERWARDS_US)
[typographical] ~51-~51: Consider adding two commas here.
Context: ...continue on normally with the new binary however running the older version. - The system...(HOWEVER_COMMA)
docs/architecture/adr-006-non-interactive-defaults.md (2)
378-378: Remove unnecessary word for conciseness.Consider removing "of" to be more concise.
- ... not only because we have to follow all of the constraints, but also because of our frequent reliance on variable length delimiters, and protobuf changing the amount of bytes used depending on the size of ints/uints. + ... not only because we have to follow all the constraints, but also because of our frequent reliance on variable length delimiters, and protobuf changing the amount of bytes used depending on the size of ints/uints.Tools
LanguageTool
[style] ~378-~378: Consider removing “of” to be more concise
Context: ...cult not only because we have to follow all of the constraints, but also because of our fr...(ALL_OF_THE)
[uncategorized] ~378-~378: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...h delimiters, and protobuf changing the amount of bytes used depending on the size of ...(AMOUNTOF_TO_NUMBEROF)
378-378: Use correct quantifier.Replace "amount of" with "number of" for countable nouns.
- ... and protobuf changing the amount of bytes used depending on the size of ints/uints. + ... and protobuf changing the number of bytes used depending on the size of ints/uints.Tools
LanguageTool
[style] ~378-~378: Consider removing “of” to be more concise
Context: ...cult not only because we have to follow all of the constraints, but also because of our fr...(ALL_OF_THE)
[uncategorized] ~378-~378: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...h delimiters, and protobuf changing the amount of bytes used depending on the size of ...(AMOUNTOF_TO_NUMBEROF)
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Hello
I found some spelling issues in your docs.
Glad I was helpful.