zev/mux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doc strings based on feedback

Browse Source
This commit is contained in:
Dj Gilcrease
2016-02-29 07:54:15 -08:00
parent f84ab9ab62
commit f7ac7251e3
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
route.go
View File

@@ -532,10 +532,11 @@ func (r *Route) URLPath(pairs ...string) (*url.URL, error) {
}, nil }, nil
} }
// GetPathTemplate and GetHostTemplate returns the template used to match against for the route // GetPathTemplate returns the template used to build the
// This is userful for building simple REST API documentation, // route match.
// and instrumentation for services like New Relic to ensure consistent reporting // This is useful for building simple REST API documentation and for instrumentation
// The route must have a path defined. // against third-party services.
// An error will be returned if the route does not define a path.
func (r *Route) GetPathTemplate() (string, error) { func (r *Route) GetPathTemplate() (string, error) {
if r.err != nil { if r.err != nil {
return "", r.err return "", r.err
@@ -546,6 +547,11 @@ func (r *Route) GetPathTemplate() (string, error) {
return r.regexp.path.template, nil return r.regexp.path.template, nil
} }
// GetHostTemplate returns the template used to build the
// route match.
// This is useful for building simple REST API documentation and for instrumentation
// against third-party services.
// An error will be returned if the route does not define a host.
func (r *Route) GetHostTemplate() (string, error) { func (r *Route) GetHostTemplate() (string, error) {
if r.err != nil { if r.err != nil {
return "", r.err return "", r.err