Skip to content

chore: fix some typos in comment - #3286

Merged
glihm merged 1 commit into
dojoengine:mainfrom
pingshuijie:main
Jul 24, 2025
Merged

chore: fix some typos in comment#3286
glihm merged 1 commit into
dojoengine:mainfrom
pingshuijie:main

Conversation

@pingshuijie

@pingshuijie pingshuijie commented Jul 22, 2025

Copy link
Copy Markdown
Contributor

Description

fix some typos 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/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

  • Documentation
    • Corrected several spelling and grammar mistakes in documentation comments for improved clarity and accuracy. No changes to functionality or user experience.

Signed-off-by: pingshuijie <pingshuijie@outlook.com>
@coderabbitai

coderabbitai Bot commented Jul 22, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Ohayo sensei! This update corrects several spelling mistakes in documentation comments across three files. The changes are limited to improving comment clarity and do not affect any code logic, structure, or public interfaces.

Changes

File(s) Change Summary
crates/dojo/core/src/world/iworld.cairo Fixed spelling in doc comment: "paralellisation" → "parallelisation"
crates/dojo/macros/src/derives/introspect/utils.rs Fixed doc comment grammar: "splitted" → "split"
crates/dojo/types/src/event.rs Fixed doc comment typo: "emmitted" → "emitted"

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

Suggested reviewers

  • kariy

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c876437 and 5900e59.

📒 Files selected for processing (3)
  • crates/dojo/core/src/world/iworld.cairo (1 hunks)
  • crates/dojo/macros/src/derives/introspect/utils.rs (1 hunks)
  • crates/dojo/types/src/event.rs (2 hunks)
🧠 Learnings (1)
crates/dojo/core/src/world/iworld.cairo (2)

Learnt from: glihm
PR: #2633
File: crates/dojo/core/src/world/storage.cairo:484-0
Timestamp: 2024-11-05T04:29:12.288Z
Learning: In the Cairo codebase for the Dojo project, within crates/dojo/core/src/world/storage.cairo, length checks between entity_ids and values are not required in test API functions like write_values_from_ids_test.

Learnt from: glihm
PR: #2633
File: crates/dojo/world/src/contracts/abigen/world.rs:3809-0
Timestamp: 2024-11-05T04:30:12.852Z
Learning: Code in crates/dojo/world/src/contracts/abigen/ is auto-generated and should be excluded from code reviews.

🧰 Additional context used
🧠 Learnings (1)
crates/dojo/core/src/world/iworld.cairo (2)

Learnt from: glihm
PR: #2633
File: crates/dojo/core/src/world/storage.cairo:484-0
Timestamp: 2024-11-05T04:29:12.288Z
Learning: In the Cairo codebase for the Dojo project, within crates/dojo/core/src/world/storage.cairo, length checks between entity_ids and values are not required in test API functions like write_values_from_ids_test.

Learnt from: glihm
PR: #2633
File: crates/dojo/world/src/contracts/abigen/world.rs:3809-0
Timestamp: 2024-11-05T04:30:12.852Z
Learning: Code in crates/dojo/world/src/contracts/abigen/ is auto-generated and should be excluded from code reviews.

🔇 Additional comments (4)
crates/dojo/core/src/world/iworld.cairo (1)

32-33: Ohayo sensei, neat spelling touch-up!

The swap to “parallelisation” polishes the docs without impacting ABI or semantics. No further action required.

crates/dojo/macros/src/derives/introspect/utils.rs (1)

65-66: Ohayo sensei, comment reads smoothly now!

“split” > “splitted” elevates readability; code remains untouched and solid.

crates/dojo/types/src/event.rs (2)

17-24: Ohayo sensei, typo exorcised!

Fixed “emitted” spelling – docs are clearer, behaviour unchanged.


26-32: Consistent clarity achieved!

Second occurrence likewise corrected; everything is in sync.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

@glihm glihm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks for the corrections. 🙏

@glihm
glihm merged commit ae2b88b into dojoengine:main Jul 24, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants