From 24763f8ce525f596e7fe27281890ce2f8f3847a6 Mon Sep 17 00:00:00 2001
From: Andrew Brown <andrew.brown@logicmonitor.com>
Date: Sat, 26 Mar 2022 16:36:25 -0500
Subject: [PATCH] update documentation comments to show intended actions of a
 'Route', in examples where a 'Router' was used;

---
 route.go | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/route.go b/route.go
index 750afe57..0f17b80d 100644
--- a/route.go
+++ b/route.go
@@ -230,7 +230,7 @@ func (m headerMatcher) Match(r *http.Request, match *RouteMatch) bool {
 // Headers adds a matcher for request header values.
 // It accepts a sequence of key/value pairs to be matched. For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     r.Headers("Content-Type", "application/json",
 //               "X-Requested-With", "XMLHttpRequest")
 //
@@ -255,7 +255,7 @@ func (m headerRegexMatcher) Match(r *http.Request, match *RouteMatch) bool {
 // HeadersRegexp accepts a sequence of key/value pairs, where the value has regex
 // support. For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     r.HeadersRegexp("Content-Type", "application/(text|json)",
 //               "X-Requested-With", "XMLHttpRequest")
 //
@@ -283,7 +283,7 @@ func (r *Route) HeadersRegexp(pairs ...string) *Route {
 //
 // For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     r.Host("www.example.com")
 //     r.Host("{subdomain}.domain.com")
 //     r.Host("{subdomain:[a-z]+}.domain.com")
@@ -342,7 +342,7 @@ func (r *Route) Methods(methods ...string) *Route {
 //
 // For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     r.Path("/products/").Handler(ProductsHandler)
 //     r.Path("/products/{key}").Handler(ProductsHandler)
 //     r.Path("/articles/{category}/{id:[0-9]+}").
@@ -377,7 +377,7 @@ func (r *Route) PathPrefix(tpl string) *Route {
 // It accepts a sequence of key/value pairs. Values may define variables.
 // For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     r.Queries("foo", "bar", "id", "{id:[0-9]+}")
 //
 // The above route will only match if the URL contains the defined queries
@@ -473,7 +473,7 @@ func (r *Route) BuildVarsFunc(f BuildVarsFunc) *Route {
 //
 // It will test the inner routes only if the parent route matched. For example:
 //
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     s := r.Host("www.example.com").Subrouter()
 //     s.HandleFunc("/products/", ProductsHandler)
 //     s.HandleFunc("/products/{key}", ProductHandler)
@@ -524,7 +524,7 @@ func (r *Route) Subrouter() *Router {
 // The scheme of the resulting url will be the first argument that was passed to Schemes:
 //
 //     // url.String() will be "https://example.com"
-//     r := mux.NewRouter()
+//     r := mux.NewRouter().NewRoute()
 //     url, err := r.Host("example.com")
 //                  .Schemes("https", "http").URL()
 //