-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Fix linter issues (docs) #370
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,8 +13,11 @@ import ( | |
) | ||
|
||
var ( | ||
// ErrMethodMismatch is returned when the error in the request does not match | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suspect "when the error in the request" should be "when the method in the request". |
||
// the method defined against the route. | ||
ErrMethodMismatch = errors.New("method is not allowed") | ||
ErrNotFound = errors.New("no matching route was found") | ||
// ErrNotFound is returned when no route match is found. | ||
ErrNotFound = errors.New("no matching route was found") | ||
) | ||
|
||
// NewRouter returns a new router instance. | ||
|
@@ -95,9 +98,9 @@ func (r *Router) Match(req *http.Request, match *RouteMatch) bool { | |
if r.MethodNotAllowedHandler != nil { | ||
match.Handler = r.MethodNotAllowedHandler | ||
return true | ||
} else { | ||
return false | ||
} | ||
|
||
return false | ||
} | ||
|
||
// Closest match for a router (includes sub-routers) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,6 +43,8 @@ type Route struct { | |
buildVarsFunc BuildVarsFunc | ||
} | ||
|
||
// SkipClean bypasses cleaning the path, which includes removing duplicate | ||
// slashes and URL encoding. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's actually not what this function does. It reports whether the SkipClean option is enabled for this route. |
||
func (r *Route) SkipClean() bool { | ||
return r.skipClean | ||
} | ||
|
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.
Maybe it'd be a good idea to remove the word "also":
When reading documentation for this method, it might be confusing. "Middleware also implements it? In addition to what?"