docs: remove inaccurate statement about PoW chains #20877
Conversation
WalkthroughWalkthroughThe change involves removing a sentence in the documentation about CometBFT BFT's significant gains in throughput when utilized with application-specific blockchains. This update reflects the intention to no longer highlight this particular performance aspect in that context. 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 Configration 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 and nitpick comments (2)
docs/learn/intro/01-why-app-specific.md (2)
71-71: Remove trailing space.There is an unnecessary trailing space at the end of the line.
- * Developers of application-specific blockchains can choose to operate with a novel consensus engine such as CometBFT BFT. + * Developers of application-specific blockchains can choose to operate with a novel consensus engine such as CometBFT BFT.Tools
Markdownlint
71-71: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
71-71: Remove unnecessary comma.The conjunction "so that" does not require a comma.
- * An application-specific blockchain only operates a single application, so that the application does not compete with others for computation and storage. + * An application-specific blockchain only operates a single application so that the application does not compete with others for computation and storage.Tools
Markdownlint
71-71: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/intro/01-why-app-specific.md (1 hunks)
Additional context used
Path-based instructions (1)
docs/learn/intro/01-why-app-specific.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
docs/learn/intro/01-why-app-specific.md
[typographical] ~72-~72: The conjunction “so that” does not require a comma.
Context: ...chain only operates a single application, so that the application does not compete with o...(SO_THAT_UNNECESSARY_COMMA)
Markdownlint
docs/learn/intro/01-why-app-specific.md
71-71: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
Additional comments not posted (1)
docs/learn/intro/01-why-app-specific.md (1)
72-72: Approved: Removal of inaccurate statement.The removal of the statement about VM-based blockchains and PoW aligns with the PR objective.
Tools
LanguageTool
[typographical] ~72-~72: The conjunction “so that” does not require a comma.
Context: ...chain only operates a single application, so that the application does not compete with o...(SO_THAT_UNNECESSARY_COMMA)
github-merge-queue
bot
removed this pull request from the merge queue due to a conflict with the base branch
|
@0xkrane hey can u resolve the conflict so we can go on merge this PR |
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/intro/01-why-app-specific.md (1 hunks)
Additional context used
Path-based instructions (1)
docs/learn/intro/01-why-app-specific.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
docs/learn/intro/01-why-app-specific.md
[typographical] ~72-~72: The conjunction “so that” does not require a comma.
Context: ...chain only operates a single application, so that the application does not compete with o...(SO_THAT_UNNECESSARY_COMMA)
Additional comments not posted (2)
docs/learn/intro/01-why-app-specific.md (2)
71-71: Confirm the removal of the inaccurate statement.The removal of the sentence mentioning CometBFT's significant gains in throughput for application-specific blockchains appears to correct an inaccuracy. Ensure the rest of the paragraph maintains clarity and correctness.
Line range hint
1-72:
Documentation is clear and accurate.The document is well-structured and effectively explains the benefits and shortcomings of application-specific blockchains. No additional grammatical errors are found.
Tools
LanguageTool
[typographical] ~72-~72: The conjunction “so that” does not require a comma.
Context: ...chain only operates a single application, so that the application does not compete with o...(SO_THAT_UNNECESSARY_COMMA)
| @@ -68,7 +68,7 @@ The list above contains a few examples that show how much flexibility applicatio | |||
|
|
|||
| Decentralized applications built with Smart Contracts are inherently capped in performance by the underlying environment. For a decentralized application to optimise performance, it needs to be built as an application-specific blockchain. Next are some of the benefits an application-specific blockchain brings in terms of performance: | |||
|
|
|||
| * Developers of application-specific blockchains can choose to operate with a novel consensus engine such as CometBFT. Compared to Proof-of-Work (used by most virtual-machine blockchains today), it offers significant gains in throughput. | |||
| * Developers of application-specific blockchains can choose to operate with a novel consensus engine such as CometBFT. | |||
| * An application-specific blockchain only operates a single application, so that the application does not compete with others for computation and storage. This is the opposite of most non-sharded virtual-machine blockchains today, where smart contracts all compete for computation and storage. | |||
There was a problem hiding this comment.
Remove unnecessary comma.
The conjunction “so that” does not require a comma.
- an application-specific blockchain only operates a single application, so that the application does not compete with others for computation and storage.
+ an application-specific blockchain only operates a single application so that the application does not compete with others for computation and storage.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * An application-specific blockchain only operates a single application, so that the application does not compete with others for computation and storage. This is the opposite of most non-sharded virtual-machine blockchains today, where smart contracts all compete for computation and storage. | |
| * An application-specific blockchain only operates a single application so that the application does not compete with others for computation and storage. This is the opposite of most non-sharded virtual-machine blockchains today, where smart contracts all compete for computation and storage. |
Tools
LanguageTool
[typographical] ~72-~72: The conjunction “so that” does not require a comma.
Context: ...chain only operates a single application, so that the application does not compete with o...(SO_THAT_UNNECESSARY_COMMA)
Description
Removing a statement that says most VM-based blockchains use PoW. This change is purely a docs change and not a code change.
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