docs: proofreading and edits #4069
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Corrected "consensus breaking" to "consensus-breaking" for proper hyphenation of compound adjectives. - Added the definite article "the" in "As specified in the [results](results.md) document" for grammatical correctness. - Minor readability improvements in phrasing without changing the meaning. -Added the article ** "a" ** before ** "16-core" ** and ** "4-core" ** (to improve grammar and sound).
MB (for megabytes) - always written with capital letters In some places, "And" in the sentences should not be started with the title letter, if this is not the beginning of a new sentence. It is better to use "And".
savvar9991
requested review from
cmwaters and
staheri14
and removed request for
a team
📝 WalkthroughWalkthroughThe changes in this pull request involve grammatical corrections and formatting adjustments in two documentation files: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
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
|
rootulp
approved these changes
Nov 29, 2024
| @@ -20,8 +20,8 @@ The results are outlined in the [results](results.md) document. | |||
|
|
|||
| ## Key takeaways | |||
|
|
|||
| We decided to softly limit the number of messages contained in a block, via introducing the `MaxPFBMessages` and `MaxNonPFBMessages`, and checking against them in prepare proposal. | |||
There was a problem hiding this comment.
PrepareProposal is the name of a step so I think it is fine to use "in prepare proposal".
rach-id
reviewed
Nov 29, 2024
| @@ -20,8 +20,8 @@ The results are outlined in the [results](results.md) document. | |||
|
|
|||
| ## Key takeaways | |||
|
|
|||
| We decided to softly limit the number of messages contained in a block, via introducing the `MaxPFBMessages` and `MaxNonPFBMessages`, and checking against them in prepare proposal. | |||
| We decided to softly limit the number of messages contained in a block, by introducing the `MaxPFBMessages` and `MaxNonPFBMessages`, and checking against them while preparing the proposal. | |||
There was a problem hiding this comment.
Suggested change
| We decided to softly limit the number of messages contained in a block, by introducing the `MaxPFBMessages` and `MaxNonPFBMessages`, and checking against them while preparing the proposal. | |
| We decided to softly limit the number of messages contained in a block, by introducing the `MaxPFBMessages` and `MaxNonPFBMessages`, and checking against them while in prepare proposal. |
As suggested by Rootul
ninabarbakadze
approved these changes
Dec 2, 2024
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Title: Update Benchmark Results and Correct Formatting
Description:
This pull request includes several updates to the benchmark documentation in the
results.mdfile. The changes primarily focus on improving the formatting, standardizing block sizes, adding commas for better readability in numeric values, and ensuring consistency in capitalization and phrasing throughout the document.Changes:
Grammar and Consistency:
MaxPFBMessagesandMaxNonPFBMessages, and checking against them while preparing the proposal."MBconsistently across the document (e.g.,8mb→8MB).Clarification in Results Descriptions:
16-core, 48GB RAM machineinstead of16 core 48GB RAM machine).Impact:
These updates will make the documentation clearer and easier to read, improving the consistency and quality of the benchmark results. This also ensures that all terms and values are uniformly presented for easier understanding and future reference.