Fix linter issues (docs) #370
Merged
Conversation
This file contains 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
kisielk
reviewed
May 1, 2018
| @@ -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.
That's actually not what this function does. It reports whether the SkipClean option is enabled for this route.
|
Ah, yes. Will fix.
…On Mon, Apr 30, 2018 at 9:23 PM Kamil Kisiel ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In route.go
<#370 (comment)>:
> @@ -43,6 +43,8 @@ type Route struct {
buildVarsFunc BuildVarsFunc
}
+// SkipClean bypasses cleaning the path, which includes removing duplicate
+// slashes and URL encoding.
That's actually not what this function does. It reports whether the
SkipClean option is enabled for this route.
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
<#370 (review)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AABIcIElAtZT-Z9dkWF3ZuKFJ5g2s8nCks5tt-MwgaJpZM4Ttg9t>
.
|
dmitshur
reviewed
May 4, 2018
| @@ -12,7 +12,7 @@ type middleware interface { | |||
| Middleware(handler http.Handler) http.Handler | |||
| } | |||
|
|
|||
| // MiddlewareFunc also implements the middleware interface. | |||
| // Middleware also implements the middleware interface. | |||
There was a problem hiding this comment.
Maybe it'd be a good idea to remove the word "also":
// Middleware implements the middleware interface.
When reading documentation for this method, it might be confusing. "Middleware also implements it? In addition to what?"
| @@ -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.
I suspect "when the error in the request" should be "when the method in the request".
|
Fixes in #375 |
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.
No description provided.