docs: document panic conditions in Handle, StaticFS, and Bind#4595
Open
Folium1 wants to merge 1 commit intogin-gonic:masterfrom
Open
docs: document panic conditions in Handle, StaticFS, and Bind#4595Folium1 wants to merge 1 commit intogin-gonic:masterfrom
Folium1 wants to merge 1 commit intogin-gonic:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4595 +/- ##
==========================================
- 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.
Pull Request Checklist
Please ensure your pull request meets the following requirements:
masterbranch.docs/doc.md.Thank you for contributing!
What this PR does
Adds panic documentation to three exported functions whose doc comments
don't mention that they can panic on invalid input:
RouterGroup.Handle— panics on invalid HTTP methodRouterGroup.StaticFS— panics when relativePath contains:or*Bind— panics when val is a pointerCallers relying on godoc have no way to discover these crash conditions
without reading the source.
Changes
Documentation only — no behavior or logic changes.
routergroup.go: added// It panics if ...toHandleandStaticFSutils.go: added// It panics if ...toBindWhy
Go convention (and the standard library itself) documents panic conditions
in doc comments. For example,
regexp.MustCompilesays"It panics if the expression cannot be parsed." These three functions
follow the same pattern but lack the documentation.