Browse Source

[docs] fix outdated UseEncodedPath method docs (#314)

https://github.com/gorilla/mux/pull/306 changed UseEncodedPath to use native go encoded path handling so cautions in it's docs are no longer applicable.
pull/318/head
Chris Dostert 8 years ago committed by Matt Silverlock
parent
commit
2d5fef06b8
  1. 4
      mux.go

4
mux.go

@ -196,10 +196,6 @@ func (r *Router) SkipClean(value bool) *Router {
// UseEncodedPath tells the router to match the encoded original path // UseEncodedPath tells the router to match the encoded original path
// to the routes. // to the routes.
// For eg. "/path/foo%2Fbar/to" will match the path "/path/{var}/to". // For eg. "/path/foo%2Fbar/to" will match the path "/path/{var}/to".
// This behavior has the drawback of needing to match routes against
// r.RequestURI instead of r.URL.Path. Any modifications (such as http.StripPrefix)
// to r.URL.Path will not affect routing when this flag is on and thus may
// induce unintended behavior.
// //
// If not called, the router will match the unencoded path to the routes. // If not called, the router will match the unencoded path to the routes.
// For eg. "/path/foo%2Fbar/to" will match the path "/path/foo/bar/to" // For eg. "/path/foo%2Fbar/to" will match the path "/path/foo/bar/to"

Loading…
Cancel
Save