chore: remove redundant words in comment

[rusttech]

Description

remove redundant words in comment

Related issue

Tests

• Yes
• No, because they aren't needed
• No, because I need help

Added to documentation?

• README.md
• Dojo Book
• No documentation needed

Checklist

• I've formatted my code (scripts/prettier.sh, scripts/rust_fmt.sh, scripts/cairo_fmt.sh)
• I've linted my code (scripts/clippy.sh, scripts/docs.sh)
• I've commented my code
• I've requested a review after addressing the comments

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced migration process with clearer comments and structured error handling.
  • Improved functionality for initializing contracts and syncing permissions/resources.

• Bug Fixes

  • Streamlined logic for checking changes during migration for better efficiency.
  • Enhanced error handling in the metadata upload process.

• Documentation

  • Updated comments for clarity in various methods related to migration and event fetching.

• Refactor

  • Refined configuration options for the KatanaRunner to improve setup flexibility.

[coderabbitai]

Walkthrough

Ohayo, sensei! This pull request introduces various modifications across several files, primarily enhancing documentation and refining existing methods without altering their core functionality. Changes include updated comments for clarity in the ChainSpec and event handling processes, as well as improvements in the migration module's logic and error handling. The KatanaRunner configuration options have been expanded, while method signatures in the migration module have been updated for better clarity and structure.

Changes

File Path	Change Summary
crates/katana/primitives/src/chain_spec.rs	Updated comments in state_updates method for clarity regarding fee tokens and UDC. No changes to logic or structure.
crates/katana/rpc/rpc/src/utils/events.rs	Clarified comments in fetch_tx_events function regarding cursor behavior. No changes to logic or structure.
crates/katana/runner/src/lib.rs	Enhanced setup_and_start method for additional configuration options. Clarified determine_default_program_path function.
crates/sozo/ops/src/migrate/mod.rs	Added detailed comments and refined migration methods for clarity and efficiency. Updated method signatures for several functions in the Migration struct.

Possibly related PRs

• hotfix(katana): missing erc20 class on custom genesis #2582: Related changes to the ChainSpec struct and fee token handling in chain_spec.rs.
• Improve Katana runner macro #2464: Improvements to the Katana runner macro, indirectly related to the Katana framework.
• feat(sozo): add events command back and event better #2619: Enhancements to the sozo events command, with minimal direct connection to chain_spec.rs.
• fix: ensure wide block range supported mainnet + refactor auth #2665: Focus on block range handling and auth system refactoring, relevant to migration process.
• refactor: rework torii CLI to be similar to katana #2674: Modifications to the Torii CLI configuration, loosely connected to configuration management in the Katana framework.
• fix(sozo): add back -vvv and add label to class declaration #2675: Changes to logging and verbosity, related to user experience improvements in Katana.
• fix: ensure the manifest existence is correctly tested #2713: Fix for manifest existence testing, relevant to migration and configuration management.
• refactor(katana): include config in the node struct #2742: Refactor to include configuration in the node struct, aligning with the main PR's focus on configuration management.

Suggested reviewers

• kariy: Suggested reviewer for this pull request.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)

crates/sozo/ops/src/migrate/mod.rs (1)

771-771: Ohayo sensei! Consider rephrasing the comment for clarity.

Rewriting the comment can improve understanding.

Suggested change:

-// We want to wait for the receipt to be able to print the
-// world block number.
+// Wait for the receipt to retrieve and display the world block number.

crates/katana/runner/src/lib.rs (1)

254-254: Ohayo sensei! Clarify the documentation comment.

Enhancing the comment for better clarity.

Suggested change:

 /// Determines the default program path for the katana runner based on the KATANA_RUNNER_BIN
-/// environment variable. If not set, try to use katana from the PATH.
+/// environment variable. If not set, it defaults to "katana" in the system PATH.

crates/katana/rpc/rpc/src/utils/events.rs (1)

340-340: Ohayo sensei! Correct minor grammatical issues in the comment.

Adjusting the comment for proper grammar and punctuation.

Suggested change:

-// start from the same event pointed by the
-// current cursor..
+// Start from the same event pointed to by the current cursor.

crates/katana/primitives/src/chain_spec.rs (1)

76-76: Ohayo sensei! Capitalize the comment for consistency.

Ensuring consistency in comment styling.

Suggested change:

-// this method will include the ETH and STRK fee tokens, and the UDC
+// This method will include the ETH and STRK fee tokens, and the UDC

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 859c9d9 and c8d8744.

📒 Files selected for processing (4)

• crates/katana/primitives/src/chain_spec.rs (1 hunks)
• crates/katana/rpc/rpc/src/utils/events.rs (1 hunks)
• crates/katana/runner/src/lib.rs (1 hunks)
• crates/sozo/ops/src/migrate/mod.rs (1 hunks)

[glihm]

Thank you @rusttech for your contribution. FYI, contributions that only fix comments typos are not eligible for only dust rewards. 👍