chore: fix a large number of spelling issues in comments #6088

joemicky · 2025-09-16T08:30:25Z

Summary of changes

Changes introduced in this pull request:

fix a large number of spelling issues in comments

Reference issue to close (if applicable)

Closes

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

Documentation
- Corrected multiple typos across modules and clarified that pending_for returns messages sorted by sequence.
Style
- Improved an error message wording in F3 manifest parsing (fixed a typo), enhancing readability.
Tests
- Fixed typos in test comments and descriptions.

No functional changes or public API modifications.

Signed-off-by: joemicky <joemickychang@outlook.com>

CLAassistant · 2025-09-16T08:30:33Z

All committers have signed the CLA.

coderabbitai · 2025-09-16T08:30:33Z

Walkthrough

Multiple files were updated to correct typos in comments, documentation, and error messages. No functional logic, control flow, tests, or public APIs were changed.

Changes

Cohort / File(s)	Summary of changes
Bitswap comments `src/libp2p_bitswap/internals/event_handlers.rs`, `src/libp2p_bitswap/request_manager.rs`	Corrected comment typos (“syncronously”→“synchronously”, “seperate”→“separate”). No code changes.
Message pool docs/tests `src/message_pool/msgpool/msg_pool.rs`, `src/message_pool/msgpool/selection.rs`	Fixed doc/comment typos and clarified that `pending_for` returns messages sorted by sequence; corrected “chain depenent”→“chain dependent” in test comments. No code changes.
RPC strings/comments `src/rpc/methods/f3/types.rs`, `src/rpc/reflect/parser.rs`	Fixed typo in error message (“offest”→“offset”) and a test comment (“postional”→“positional”). No logic changes.
Tooling test comments `src/tool/subcommands/api_cmd/api_compare_tests.rs`	Corrected comment typo (“garanteed”→“guaranteed”). No code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

hanabi1224
LesnyRumcajs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "chore: fix a large number of spelling issues in comments" accurately and concisely summarizes the primary change in the PR: correcting typos in comments and test strings across multiple files with no functional or API changes, as shown in the raw_summary and PR objectives. It is specific enough for a teammate scanning history to understand the intent and contains no extraneous details. Therefore it meets the title guidelines.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (6)

src/rpc/reflect/parser.rs (1)

1-399: Consider adding automated spell‑check in CI.

Given the nature of this PR, add a repo‑wide spell checker (e.g., typos/codespell) and a pre‑commit hook to prevent regressions.
src/libp2p_bitswap/request_manager.rs (1)
70-71: Minor grammar tweak in the updated comment.

“other type of requests” → “other types of requests”.

Apply this diff:
-        // Use separate channels here to not block `block` requests when too many other type of requests are queued.
+        // Use separate channels here to not block `block` requests when too many other types of requests are queued.
src/tool/subcommands/api_cmd/api_compare_tests.rs (1)
1196-1204: Fix residual typo in nearby comment.

“invocking” → “invoking”.

Apply this diff:
-            // Both Forest and Lotus should fail miserably at invocking Cthulhu's name
+            // Both Forest and Lotus should fail miserably at invoking Cthulhu's name
src/rpc/methods/f3/types.rs (1)
371-374: Fix typo in constant string.

“indexing slicling” → “indexing/slicing”.

Apply this diff:
-        const INDEXING_SLICING_ERROR: &str = "unexpected overflow in indexing slicling";
+        const INDEXING_SLICING_ERROR: &str = "unexpected overflow in indexing/slicing";
src/message_pool/msgpool/selection.rs (2)
524-526: Fix minor typo in comment.

“hae” → “have”.

Apply this diff:
-        // 7. We have reached the edge of what can fit wholesale; if we still hae
+        // 7. We have reached the edge of what can fit wholesale; if we still have
1303-1311: Fix minor typo in comment.

“uneselectable” → “unselectable”.

Apply this diff:
-        // address 2 (uneselectable) message is worth so much!
+        // address 2 (unselectable) message is worth so much!

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02861dd and a64f26e.

📒 Files selected for processing (7)

src/libp2p_bitswap/internals/event_handlers.rs (1 hunks)
src/libp2p_bitswap/request_manager.rs (1 hunks)
src/message_pool/msgpool/msg_pool.rs (1 hunks)
src/message_pool/msgpool/selection.rs (2 hunks)
src/rpc/methods/f3/types.rs (1 hunks)
src/rpc/reflect/parser.rs (1 hunks)
src/tool/subcommands/api_cmd/api_compare_tests.rs (1 hunks)

🔇 Additional comments (7)

src/rpc/reflect/parser.rs (1)

279-284: Typo fix LGTM.

Comment spelling correction is accurate; no behavior change.

src/libp2p_bitswap/internals/event_handlers.rs (1)

16-16: Typo fix LGTM.

“Synchronously” reads correctly; no code changes.

src/tool/subcommands/api_cmd/api_compare_tests.rs (1)

1994-1996: Typo fix LGTM.

“guaranteed” spelling fix only; no behavioral impact.

src/rpc/methods/f3/types.rs (1)

415-416: Error message spelling fix LGTM.

“offset” is correct; logic unchanged.

src/message_pool/msgpool/selection.rs (2)

1473-1475: Typo fix LGTM.

“chain dependent” wording is fine; comment‑only change.

1559-1562: Typo fix LGTM.

“chain dependent” correction in test comment looks good.

src/message_pool/msgpool/msg_pool.rs (1)

389-396: Doc tweak LGTM.

Clarifies that results are sorted by each message’s sequence; matches implementation below.

LesnyRumcajs · 2025-09-16T09:05:04Z

Thanks!

chore: fix a large number of spelling issues in comments

a64f26e

Signed-off-by: joemicky <joemickychang@outlook.com>

joemicky requested a review from a team as a code owner September 16, 2025 08:30

joemicky requested review from akaladarshi and hanabi1224 and removed request for a team September 16, 2025 08:30

coderabbitai bot reviewed Sep 16, 2025

View reviewed changes

LesnyRumcajs approved these changes Sep 16, 2025

View reviewed changes

LesnyRumcajs enabled auto-merge September 16, 2025 09:05

hanabi1224 approved these changes Sep 16, 2025

View reviewed changes

LesnyRumcajs added this pull request to the merge queue Sep 16, 2025

Merged via the queue into ChainSafe:main with commit d83ccef Sep 16, 2025
37 checks passed

coderabbitai bot mentioned this pull request Oct 6, 2025

Extend cargo-spellcheck to cover entire repository including .github directory #6062

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: fix a large number of spelling issues in comments #6088

chore: fix a large number of spelling issues in comments #6088

Uh oh!

joemicky commented Sep 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

CLAassistant commented Sep 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Sep 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

LesnyRumcajs commented Sep 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: fix a large number of spelling issues in comments #6088

chore: fix a large number of spelling issues in comments #6088

Uh oh!

Conversation

joemicky commented Sep 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Summary by CodeRabbit

Uh oh!

CLAassistant commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

LesnyRumcajs commented Sep 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joemicky commented Sep 16, 2025 •

edited by coderabbitai bot

Loading

CLAassistant commented Sep 16, 2025 •

edited

Loading

coderabbitai bot commented Sep 16, 2025 •

edited

Loading