From d70d300422f0de0fa4aaf08a2fd05c733be3a316 Mon Sep 17 00:00:00 2001
From: elotreum <59893399+elotreum@users.noreply.github.com>
Date: Mon, 20 Jan 2020 11:31:45 -0700
Subject: [PATCH] add godoc explaining catch-all parameter matching for ByName

---
 bittorrent/params.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/bittorrent/params.go b/bittorrent/params.go
index 5429894..b820108 100644
--- a/bittorrent/params.go
+++ b/bittorrent/params.go
@@ -72,6 +72,10 @@ type RouteParams []RouteParam
 
 // ByName returns the value of the first RouteParam that matches the given
 // name. If no matching RouteParam is found, an empty string is returned.
+// In the event that a "catch-all" parameter is provided on the route and
+// no value is matched, an empty string is returned. For example: a route of
+// "/announce/*param" matches on "/announce/". However, ByName("param") will
+// return an empty string.
 func (rp RouteParams) ByName(name string) string {
 	for _, p := range rp {
 		if p.Key == name {