Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typographical errors in multiple files #4078

Merged
merged 8 commits into from
Dec 3, 2024

Conversation

dramarereg
Copy link
Contributor

Corrected the following typographical errors in various files:

  • square_size.go
  • adr-021-restricted-block-size.md
  • max_total_blob_size_ante.go
  • blob_share_decorator.go
  • cat_pool.md
  • adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md
  • README.md

Changes made:

  1. Fixed typos in function comments and documentation.
  2. Corrected spelling mistakes and improved consistency in file descriptions.
  3. Adjusted formatting in documentation to improve readability.

@dramarereg dramarereg requested review from liamsi and a team as code owners December 3, 2024 18:27
@dramarereg dramarereg requested review from cmwaters and ninabarbakadze and removed request for a team December 3, 2024 18:27
@celestia-bot celestia-bot requested a review from a team December 3, 2024 18:27
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

📝 Walkthrough

Walkthrough

The pull request includes modifications across several files, primarily addressing typographical errors in comments and documentation. Key changes involve correcting the spelling of "PrepareProposal" in multiple locations and updating the status of proposed optimizations in architectural documents. Additionally, a new governance parameter, GovMaxSquareSize, has been introduced in one of the architecture documents to enhance block size management. Overall, the changes focus on improving clarity and accuracy without altering the underlying functionality.

Changes

File Path Change Summary
app/square_size.go Corrected "PreparePropsoal" to "PrepareProposal" in the comment of MaxEffectiveSquareSize method.
x/blob/ante/blob_share_decorator.go Corrected "PreparePropsoal" to "PrepareProposal" in the comment of getMaxSquareSize method.
x/blob/ante/max_total_blob_size_ante.go Corrected "PreparePropsoal" to "PrepareProposal" in the comment of getMaxSquareSize method.
docs/architecture/adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md Updated status of proposed optimizations to "Declined" and clarified sections regarding proofs and their implications.
docs/architecture/adr-021-restricted-block-size.md Introduced new governance parameter GovMaxSquareSize and updated methods to utilize this parameter.
specs/src/cat_pool.md Clarified specifications for the Content Addressable Transaction Pool (CAT) protocol and introduced new protobuf messages.
x/tokenfilter/README.md Corrected "beholdent" to "beholden" in the context of token transfers.

Possibly related PRs

Suggested labels

external

Suggested reviewers

  • liamsi
  • evan-forbes
  • rootulp
  • ninabarbakadze
  • cmwaters

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
docs/architecture/adr-021-restricted-block-size.md (1)

109-109: Improve comment formatting for better readability

The line is too long and wraps awkwardly. Consider breaking it into multiple lines for better readability.

-	// of the sdk and comet that have full support of PrepareProposal, although
+	// of the SDK and Comet that have full support of PrepareProposal, although
+	// celestia-app does not currently use those. See this PR for more details:
+	// https://github.com/cosmos/cosmos-sdk/pull/14505
specs/src/cat_pool.md (1)

63-63: Enhance clarity of the SeenTx broadcasting requirement

The current wording could be more precise to emphasize this critical requirement.

-The `SeenTx` message MUST only be broadcasted after validation and storage.
+The `SeenTx` message MUST only be broadcasted after successful validation and confirmed storage of the transaction.
docs/architecture/adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md (1)

54-54: Maintain consistent list formatting

The line breaks the bullet point formatting pattern of the list.

-- how long the blob is
+- length of the blob
x/tokenfilter/README.md (1)

10-10: Consider adding a comma after 'Thus'.

For improved readability and proper grammar, consider adding a comma after the conjunctive adverb "Thus".

-Thus tokens moved to a non-native state machine are beholden to the security of both chains.
+Thus, tokens moved to a non-native state machine are beholden to the security of both chains.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ...n chain minting a "wrapped" equivalent. Thus tokens moved to a non-native state mach...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 615f1dc and bcc952f.

📒 Files selected for processing (7)
  • app/square_size.go (1 hunks)
  • docs/architecture/adr-011-optimistic-blob-size-independent-inclusion-proofs-and-pfb-fraud-proofs.md (1 hunks)
  • docs/architecture/adr-021-restricted-block-size.md (1 hunks)
  • specs/src/cat_pool.md (1 hunks)
  • x/blob/ante/blob_share_decorator.go (1 hunks)
  • x/blob/ante/max_total_blob_size_ante.go (1 hunks)
  • x/tokenfilter/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • x/blob/ante/max_total_blob_size_ante.go
  • app/square_size.go
  • x/blob/ante/blob_share_decorator.go
🧰 Additional context used
🪛 LanguageTool
x/tokenfilter/README.md

[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ...n chain minting a "wrapped" equivalent. Thus tokens moved to a non-native state mach...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

🔇 Additional comments (1)
x/tokenfilter/README.md (1)

10-10: LGTM! Correct terminology used.

The term "beholden" is appropriately used in this context, accurately describing the security relationship between chains in IBC token transfers.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ...n chain minting a "wrapped" equivalent. Thus tokens moved to a non-native state mach...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

@rootulp rootulp changed the title Fix: typographical errors in multiple files fix: typographical errors in multiple files Dec 3, 2024
@rootulp rootulp enabled auto-merge (squash) December 3, 2024 20:09
@rootulp rootulp merged commit e90888b into celestiaorg:main Dec 3, 2024
31 of 32 checks passed
Copy link

gitpoap-bot bot commented Dec 3, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

GitPOAP: 2024 Celestia Contributor GitPOAP Badge

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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants