Fix ShouldBindBodyWith docs example using binding.Form - #4766
Open
Hashim1999164 wants to merge 1 commit into
Open
Fix ShouldBindBodyWith docs example using binding.Form#4766Hashim1999164 wants to merge 1 commit into
Hashim1999164 wants to merge 1 commit into
Conversation
binding.Form does not implement BindingBody, so the docs example could not compile or run. Use binding.JSON instead. Fixes gin-gonic#3296
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4766 +/- ##
==========================================
- Coverage 99.21% 98.32% -0.89%
==========================================
Files 42 48 +6
Lines 3182 3172 -10
==========================================
- Hits 3157 3119 -38
- Misses 17 43 +26
- Partials 8 10 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ShouldBindBodyWithexample indocs/doc.mdusedbinding.Form, which does not implementBindingBody, so that call is invalid.binding.JSON, which matches the supported body binders listed in the same section.Fixes #3296
Test plan
docs/doc.mdcompiles conceptually againstShouldBindBodyWith/BindingBodyFormshould useShouldBindinstead ofShouldBindBodyWith