Skip to content

docs: Fix more typos across code base#3465

Merged
ReneWerner87 merged 1 commit intomainfrom
codex/find-and-fix-typos
May 21, 2025
Merged

docs: Fix more typos across code base#3465
ReneWerner87 merged 1 commit intomainfrom
codex/find-and-fix-typos

Conversation

@gaby
Copy link
Member

@gaby gaby commented May 21, 2025 •
edited
Loading

Summary

  • revert 'bound' typo fixes in bind.go
  • keep binded terminology in templates guide

@gaby gaby requested a review from a team as a code owner May 21, 2025 12:24
@gaby gaby requested review from ReneWerner87, efectn and sixcolors May 21, 2025 12:24
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 21, 2025 •
edited
Loading

Walkthrough

This update corrects typographical and grammatical errors in comments and documentation across several files. No functional code or logic has been changed; all modifications are limited to improving clarity and accuracy in documentation and code comments.

Changes

File(s) Change Summary
app_test.go Fixed recurring typo "requrested" to "requested" in test comments.
docs/guide/routing.md Improved grammar and clarity in the "Parameters" section and corrected a heading.
listen.go Corrected grammar in the comment for the prepareListenData method.
router.go Fixed grammatical error in the comment for the RebuildTree method.

Suggested labels

📒 Documentation, v3

Suggested reviewers

  • sixcolors
  • efectn

Poem

A bunny with a keen, sharp eye,
Hopped through the docs and found a lie—
"Requrested" became "requested,"
Grammar rules were all attested.
With every hop, the words align,
Clearer code—how sweet, how fine!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f1bd19 and 9edffea.

📒 Files selected for processing (4)
  • app_test.go (5 hunks)
  • docs/guide/routing.md (1 hunks)
  • listen.go (1 hunks)
  • router.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Analyse
  • GitHub Check: unit (1.23.x, macos-13)
  • GitHub Check: unit (1.24.x, windows-latest)
  • GitHub Check: unit (1.24.x, macos-latest)
  • GitHub Check: unit (1.24.x, macos-13)
  • GitHub Check: Compare
  • GitHub Check: unit (1.23.x, windows-latest)
  • GitHub Check: repeated
🔇 Additional comments (9)
router.go (1)

512-512: Corrected comment grammar for clarity.
Changing "does not makes sure" to "does not make sure" fixes the verb form and enhances readability without altering functionality.

listen.go (1)

312-312: Fixed grammatical error in method comment.
Updating "prepareListenData create an slice" to "prepareListenData creates a slice" corrects the verb agreement and article usage.

app_test.go (5)

532-532: Improved test comment grammar.
Updating "right letters in the requrested route" to "right letters in the requested route" corrects the spelling of "requested".

568-568: Clarified test comment wording.
Changing "right path in the requrested route" to "right path in the requested route" corrects the spelling.

578-578: Corrected test comment spelling.
Updating "right path with group in the requrested route" to "right path with group in the requested route" fixes the typo.

648-648: Fixed spelling in strict-routing test comment.
Changing "right path in the requrested route" to "right path in the requested route" corrects the spelling.

658-658: Adjusted test comment for clarity.
Updating "right path with group in the requrested route" to "right path with group in the requested route" corrects the typo.

docs/guide/routing.md (2)

51-51: Enhanced documentation grammar.
Refining the sentence structure improves clarity: "These segments are used to capture…" reads more naturally than the previous phrasing.

59-59: Corrected heading grammar.
Changing "Example of define routes" to "Example of defining routes" fixes the gerund form for proper English usage.

✨ Finishing Touches
  • 📝 Generate Docstrings

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@codecov
Copy link

codecov bot commented May 21, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.36%. Comparing base (1f1bd19) to head (9edffea).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3465   +/-   ##
=======================================
  Coverage   84.36%   84.36%           
=======================================
  Files         120      120           
  Lines       12140    12140           
=======================================
  Hits        10242    10242           
  Misses       1468     1468           
  Partials      430      430
Flag Coverage Δ
unittests 84.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gaby gaby added this to v3 May 21, 2025
@gaby gaby moved this to In Progress in v3 May 21, 2025
@gaby gaby added this to the v3 milestone May 21, 2025
@gaby gaby added the v3 label May 21, 2025
@gaby gaby changed the title Fix docs to keep coding term Binded docs: Fix more typos across code base May 21, 2025
@ReneWerner87 ReneWerner87 merged commit 273df5f into main May 21, 2025
19 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in v3 May 21, 2025
@gaby gaby deleted the codex/find-and-fix-typos branch May 21, 2025 12:35
@coderabbitai coderabbitai bot mentioned this pull request Aug 26, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ReneWerner87 ReneWerner87 ReneWerner87 approved these changes

@sixcolors sixcolors Awaiting requested review from sixcolors sixcolors is a code owner automatically assigned from gofiber/maintainers

@efectn efectn Awaiting requested review from efectn efectn is a code owner automatically assigned from gofiber/maintainers

Assignees

No one assigned

Labels

codex 📒 Documentation v3

Projects

v3
Status: Done

Milestone

v3.0.0

Development

Successfully merging this pull request may close these issues.

2 participants

@gaby @ReneWerner87