Skip to content

📚 docs: Fix typos in documentation#3695

Merged
gaby merged 1 commit intogofiber:mainfrom
myfloss:fix-typos
Aug 21, 2025
Merged

📚 docs: Fix typos in documentation#3695
gaby merged 1 commit intogofiber:mainfrom
myfloss:fix-typos

Conversation

@kianmeng
Copy link
Contributor

@kianmeng kianmeng commented Aug 20, 2025

Description

Fix typos found via codespell -L te,nd and typos --hidden --format brief

Fixes # (issue)

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

Found via `codespell -L te,nd` and `typos --hidden --format brief`
@kianmeng kianmeng requested a review from a team as a code owner August 20, 2025 18:01
@welcome
Copy link

welcome bot commented Aug 20, 2025

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 20, 2025

Walkthrough

Grammar corrections in panic messages within binder/msgpack.go and aligned test expectations in binder/msgpack_test.go. A test function in client/request_test.go was renamed for spelling consistency. No logic, control flow, or API changes.

Changes

Cohort / File(s) Summary of Changes
Msgpack panic message grammar fix
binder/msgpack.go, binder/msgpack_test.go
Corrected panic message text from “Must explicits setup Msgpack” to “Must explicit setup Msgpack”; updated tests to assert new substring. No functional changes.
Test name spelling correction
client/request_test.go
Renamed test function from Test_Request_Unsupport_Protocol to Test_Request_Unsupported_Protocol. No test logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

📒 Documentation, v3, codex

Suggested reviewers

  • gaby
  • sixcolors
  • ReneWerner87
  • efectn

Poem

A hop and a tweak in the warren of text,
I nibbled a typo and bounded to next.
No wires were moved, no routes rearranged—
just polished the signs where errors were ranged.
Thump-thump! says the hare: “Grammar enhanced!” 🥕✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @kianmeng, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the overall code quality and consistency by addressing various typos identified through automated tools like codespell and typos. The changes span across different file types, including configuration files, Go source code, and test files, ensuring greater accuracy and professionalism in the codebase.

Highlights

  • Configuration File Update: Corrected a typo from "bumb" to "bump" in the .github/labeler.yml file, affecting the regex for dependency labels.
  • Go Source Code and Test File Correction: Fixed the word "explicits" to "explicit" in panic messages within binder/msgpack.go and its corresponding test file binder/msgpack_test.go.
  • Test Function Renaming: Renamed the Test_Request_Unsupport_Protocol function to Test_Request_Unsupported_Protocol in client/request_test.go to correct a grammatical error.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes several typos across the codebase. My review includes suggestions to further improve the grammar of one of the updated error messages for better clarity, along with the necessary changes in the corresponding tests.


func UnimplementedMsgpackMarshal(_ any) ([]byte, error) {
panic("Must explicits setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

While fixing the typo from explicits to explicit is good, the grammar can be further improved for clarity. "Must explicit setup" is slightly awkward. Using an adverb explicitly and splitting setup into set up would make the error message more natural and professional.

Suggested change
panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
panic("Must explicitly set up Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")


func UnimplementedMsgpackUnmarshal(_ []byte, _ any) error {
panic("Must explicits setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Similar to the comment above, let's improve the grammar of this panic message for better clarity. "Must explicit setup" should be changed to "Must explicitly set up".

Suggested change
panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
panic("Must explicitly set up Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")

defer func() {
if r := recover(); r != nil {
require.Contains(t, r, "Must explicits setup Msgpack")
require.Contains(t, r, "Must explicit setup Msgpack")
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To align with the suggested change in binder/msgpack.go, this test assertion should be updated to check for the grammatically improved error message.

Suggested change
require.Contains(t, r, "Must explicit setup Msgpack")
require.Contains(t, r, "Must explicitly set up Msgpack")

defer func() {
if r := recover(); r != nil {
require.Contains(t, r, "Must explicits setup Msgpack")
require.Contains(t, r, "Must explicit setup Msgpack")
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To align with the suggested change in binder/msgpack.go, this test assertion should also be updated to check for the grammatically improved error message.

Suggested change
require.Contains(t, r, "Must explicit setup Msgpack")
require.Contains(t, r, "Must explicitly set up Msgpack")

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

🧹 Nitpick comments (2)
binder/msgpack.go (1)

28-29: Tighten grammar in panic messages (“explicitly set up”)

Minor nit: “Must explicit setup” is still slightly awkward. Consider “You must explicitly set up …” for correct phrasing. If you adopt this, update the corresponding tests too.

Apply this diff here:

-	panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
+	panic("You must explicitly set up Msgpack. See docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")

and here:

-	panic("Must explicit setup Msgpack, please check docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")
+	panic("You must explicitly set up Msgpack. See docs: https://docs.gofiber.io/next/guide/advance-format#msgpack")

Also applies to: 32-33

binder/msgpack_test.go (1)

113-114: If adjusting the panic text, align the test substring accordingly

Only needed if you take the suggested grammar tweak in binder/msgpack.go. Update the expected substring to match.

-			require.Contains(t, r, "Must explicit setup Msgpack")
+			require.Contains(t, r, "You must explicitly set up Msgpack")

and

-			require.Contains(t, r, "Must explicit setup Msgpack")
+			require.Contains(t, r, "You must explicitly set up Msgpack")

Also applies to: 126-127

📜 Review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ac909e8 and 28c89ca.

⛔ Files ignored due to path filters (1)
  • .github/labeler.yml is excluded by !**/*.yml
📒 Files selected for processing (3)
  • binder/msgpack.go (1 hunks)
  • binder/msgpack_test.go (2 hunks)
  • client/request_test.go (1 hunks)
🔇 Additional comments (1)
client/request_test.go (1)

820-827: Test name grammar fix looks good

Renaming to Test_Request_Unsupported_Protocol improves clarity and aligns with common terminology. No functional changes; assertions remain valid.

@codecov
Copy link

codecov bot commented Aug 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.81%. Comparing base (ac909e8) to head (28c89ca).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3695   +/-   ##
=======================================
  Coverage   91.81%   91.81%           
=======================================
  Files         114      114           
  Lines       11498    11498           
=======================================
  Hits        10557    10557           
  Misses        681      681           
  Partials      260      260           
Flag Coverage Δ
unittests 91.81% <100.00%> (ø)

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 the v3 label Aug 21, 2025
@gaby gaby added this to v3 Aug 21, 2025
@gaby gaby added this to the v3 milestone Aug 21, 2025
@gaby gaby changed the title 📚 docs: Fix typos 📚 docs: Fix typos in documentation Aug 21, 2025
@gaby gaby merged commit 8fc239f into gofiber:main Aug 21, 2025
15 of 16 checks passed
@github-project-automation github-project-automation bot moved this to Done in v3 Aug 21, 2025
@welcome
Copy link

welcome bot commented Aug 21, 2025

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@kianmeng
Copy link
Contributor Author

🥳 🥳 🥳 🥳 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants