docs: add panic conditions documentation for Handle, StaticFS, and Bind#4607
Open
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Open
docs: add panic conditions documentation for Handle, StaticFS, and Bind#4607xingzihai wants to merge 1 commit intogin-gonic:masterfrom
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Conversation
This commit adds documentation for panic conditions in three exported functions: - Handle: panics if httpMethod is not a valid HTTP method (uppercase ASCII letters only) - StaticFS: panics if relativePath contains URL parameters (: or *) - Bind: panics if val is a pointer Fixes gin-gonic#4594
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4607 +/- ##
==========================================
- Coverage 99.21% 98.37% -0.84%
==========================================
Files 42 48 +6
Lines 3182 3138 -44
==========================================
- Hits 3157 3087 -70
- Misses 17 42 +25
- Partials 8 9 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 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
This PR adds documentation for panic conditions in three exported functions:
Motivation
Three exported public API functions contain panic() calls on invalid input, but none of the doc comments mention the panic conditions. Callers cannot discover the crash risk without reading the source. This is a documentation gap — the panics themselves are reasonable startup-time guards, but they should be documented.
Changes
Added panic condition documentation to each function's doc comment:
RouterGroup.Handlein routergroup.goRouterGroup.StaticFSin routergroup.goBindin utils.goRelated Issue
Fixes #4594
Testing
This is a documentation-only change. No functional code changes were made.
Checklist