Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📒 doc: Add ctx.Drop() to whats_new.md #3284

Merged
merged 1 commit into from
Jan 18, 2025
Merged

Conversation

aliziyacevik
Copy link
Contributor

Description

Added missing Drop() documentation to whats_new.md

Fixes #3282

Changes introduced

Type of change

  • [ ✔️ ] Documentation update (changes to documentation)

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.
  • [:heavy_check_mark: ] 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.

@aliziyacevik aliziyacevik requested a review from a team as a code owner January 18, 2025 12:15
@aliziyacevik aliziyacevik requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team January 18, 2025 12:15
Copy link

welcome bot commented Jan 18, 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

Copy link
Contributor

coderabbitai bot commented Jan 18, 2025

Walkthrough

The pull request introduces significant updates to the Fiber framework's version 3, focusing on method signature changes, routing enhancements, and context handling mechanisms. The changes primarily involve updating router methods to require a single handler with optional middleware, removing deprecated methods, introducing new customization methods, and improving context interface flexibility. The modifications aim to provide developers with more clarity, performance, and extensibility in their web application development.

Changes

File Change Summary
router.go Updated method signatures for HTTP methods (Get, Head, Post, etc.) to separate primary handler and middleware
app.go Modified Test method to accept TestConfig, updated NewCtxFunc to work with new context interface
docs/whats_new.md Comprehensive documentation of framework changes for version 3

Assessment against linked issues

Objective Addressed Explanation
Add ctx.Drop() to whats_new.md [#3282] Documentation for c.Drop() is not explicitly mentioned in the current changes

Possibly related PRs

Suggested labels

📒 Documentation

Suggested reviewers

  • gaby
  • sixcolors
  • ReneWerner87
  • efectn

Poem

🐰 In Fiber's realm of code so bright,
Methods dance with newfound might,
Routing shifts, contexts unfurl,
A framework's magic starts to swirl!
Version 3 leaps with rabbit's delight! 🚀


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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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 (1)
docs/whats_new.md (1)

345-345: LGTM! Consider enhancing the documentation with an example.

The documentation for the Drop() method is clear and well-placed. The description effectively explains its purpose and use cases.

Consider adding a code example to demonstrate its usage, similar to other methods in the documentation. Here's a suggested example to add:

app.Get("/sensitive", func(c fiber.Ctx) error {
    if !isAuthorized(c) {
        // Silently terminate the connection without response
        return c.Drop()
    }
    return c.SendString("Authorized access")
})
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a42ddc1 and b31184e.

📒 Files selected for processing (1)
  • docs/whats_new.md (1 hunks)

Copy link
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

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

👍 LGTM

@gaby gaby changed the title [Maintenance]: Added ctx.Drop() to whats_new.md 📒 doc: Add ctx.Drop() to whats_new.md Jan 18, 2025
@gaby gaby merged commit 156897e into gofiber:main Jan 18, 2025
3 checks passed
Copy link

welcome bot commented Jan 18, 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

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

Successfully merging this pull request may close these issues.

🧹 [Maintenance]: Add ctx.Drop() to whats_new.md
3 participants