-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Fix misleading Context.Bind documentation comment #2821
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
Conversation
Addresses issue #2382 by correcting the confusing comment on Context.Bind that did not accurately describe the actual binding behavior. **Problem:** The previous comment said "Bind binds path params, query params and the request body" which was incomplete and misleading because: - It didn't explain the binding ORDER (path → query → body) - It didn't mention that later steps can OVERRIDE earlier values - It didn't specify that query params are only bound for GET/DELETE/HEAD - It didn't reference single-source binding methods **Solution:** Updated the comment to clearly explain: - The exact binding order (1) path params, 2) query params, 3) body) - Override behavior between steps - HTTP method-specific behavior for query params - References to single-source binding methods - Content-Type handling for body binding This prevents confusion for developers who might expect different behavior from Context.Bind() based on the previous misleading documentation. Fixes #2382 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Fixes misleading documentation for the Context.Bind method by providing a more comprehensive and accurate comment that explains the binding order, override behavior, HTTP method specifics, and alternative single-source binding methods.
- Updated the comment to clearly specify the binding order: path parameters → query parameters → request body
- Added information about query parameter binding limitations and override behavior
- Referenced alternative single-source binding methods for more granular control
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Summary
Addresses issue #2382 by correcting the misleading comment on
Context.Bindthat did not accurately describe the actual binding behavior.Problem
The comment on
Context.Bindincontext.gowas incomplete and confusing:Previous comment:
Issues with the old comment:
Solution
New accurate comment:
Improvements:
Impact
This fix prevents confusion for developers who might expect different behavior from
Context.Bind()based on the previous misleading documentation. Now the comment accurately reflects the actual implementation inbind.go.Type of Change
Testing
DefaultBinder.BindimplementationFixes #2382
This is a simple documentation improvement that enhances clarity for Echo developers using the binding functionality.