vendor
/
gorilla_mux
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

[docs] Document route.Get* methods consistently (#338) 

They actually return an error instead of an empty list. `GetMethods` happened to not return an error, but it should for consistency, so I added that as well.
pull/340/head
Kamil Kisiel 8 years ago committed by Matt Silverlock
parent
dc83507598
commit
077b44c2cf
1 changed files with 4 additions and 4 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      route.go

8
route.go
Unescape View File

@ -622,7 +622,7 @@ func (r *Route) GetPathRegexp() (string, error) {
// route queries. // route queries.
// This is useful for building simple REST API documentation and for instrumentation // This is useful for building simple REST API documentation and for instrumentation
// against third-party services. // against third-party services.
// An empty list will be returned if the route does not have queries. // An error will be returned if the route does not have queries.
func (r *Route) GetQueriesRegexp() ([]string, error) { func (r *Route) GetQueriesRegexp() ([]string, error) {
if r.err != nil { if r.err != nil {
return nil, r.err return nil, r.err
@ -641,7 +641,7 @@ func (r *Route) GetQueriesRegexp() ([]string, error) {
// query matching. // query matching.
// This is useful for building simple REST API documentation and for instrumentation // This is useful for building simple REST API documentation and for instrumentation
// against third-party services. // against third-party services.
// An empty list will be returned if the route does not define queries. // An error will be returned if the route does not define queries.
func (r *Route) GetQueriesTemplates() ([]string, error) { func (r *Route) GetQueriesTemplates() ([]string, error) {
if r.err != nil { if r.err != nil {
return nil, r.err return nil, r.err
@ -659,7 +659,7 @@ func (r *Route) GetQueriesTemplates() ([]string, error) {
// GetMethods returns the methods the route matches against // GetMethods returns the methods the route matches against
// This is useful for building simple REST API documentation and for instrumentation // This is useful for building simple REST API documentation and for instrumentation
// against third-party services. // against third-party services.
// An empty list will be returned if route does not have methods. // An error will be returned if route does not have methods.
func (r *Route) GetMethods() ([]string, error) { func (r *Route) GetMethods() ([]string, error) {
if r.err != nil { if r.err != nil {
return nil, r.err return nil, r.err
@ -669,7 +669,7 @@ func (r *Route) GetMethods() ([]string, error) {
return []string(methods), nil return []string(methods), nil
} }
} }
return nil, nil return nil, errors.New("mux: route doesn't have methods")
} }
// GetHostTemplate returns the template used to build the // GetHostTemplate returns the template used to build the

Write Preview
Loading…
Cancel
Save