📚 Doc: Clarify SendFile Docs

[xEricL]

Description

These changes include:

• Adds fiber. to SendFile for the SendFile config parameter in the docs.
• Clarifies that the ContentType header is set based on the format of the file if the file extension is missing/invalid.
• Adds unit-tests to verify the ContentType header is set as described.
• Makes the formatting of default values for SendFile struct fields consistent (matching the FS field and most middleware configs.
• Adds missing hyphens for usage of case sensitive (Not related to Sendfile but I noticed it when I was refactoring).

Changes introduced

• [x] Documentation Update: Fix typos and clarify SendFile usage.

Type of change

• [x] Documentation update (changes to documentation)

Checklist

• [x] Updated the documentation in the /docs/ directory for Fiber's documentation.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request involve updates primarily focused on improving documentation across several files in the fiber package. Modifications include clarifying comments in struct definitions, enhancing method documentation, and refining test cases to improve code coverage and error handling. Additionally, new methods and examples were introduced in the documentation to better illustrate functionality. Overall, these changes aim to enhance clarity and consistency without altering the underlying functionality of the code.

Changes

File	Change Summary
app.go	Updated comments for CaseSensitive and StrictRouting fields in the Config struct for clarity.
app_test.go	Enhanced test cases including new tests for error handling, route naming, and added benchmark tests.
ctx.go	Updated comments in SendFile struct and method for clarity on default values and Content-Type handling.
ctx_interface_gen.go	Clarified documentation for SendFile method in the Ctx interface regarding compression and Content-Type.
docs/api/ctx.md	Comprehensive updates to Ctx documentation including method signature changes, new method introduction, and example updates.
router.go	Updated comments in Route struct and methods to clarify case sensitivity in parameter keys and path processing.

Possibly related PRs

• #3170: The changes in this PR involve updates to the Config struct, including renaming fields and enhancing documentation, which is directly related to the modifications made to the Config struct in the main PR.

Suggested labels

📒 Documentation, 🧹 Updates

Suggested reviewers

• sixcolors
• gaby
• efectn
• ReneWerner87

Poem

In the code where rabbits hop,
Comments now shine, they never stop!
With clarity bright, and tests galore,
Fiber's framework, we all adore!
Documentation, a joyful dance,
Enhancing our code, giving it a chance! 🐇✨

---

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.

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[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.69%. Comparing base (9a72704) to head (727156a). Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3172      +/-   ##
==========================================
- Coverage   82.75%   82.69%   -0.06%     
==========================================
  Files         114      114              
  Lines       11149    11149              
==========================================
- Hits         9226     9220       -6     
- Misses       1523     1527       +4     
- Partials      400      402       +2     

Flag	Coverage Δ
unittests	82.69% <ø> (-0.06%)	:arrow_down:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.