Add comment to new exported function

cli · Oct 14, 2024 · 6a5df44 · 6a5df44
1 parent 98f5bb4
commit 6a5df44
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pkg/auth/auth.go b/pkg/auth/auth.go
@@ -165,6 +165,9 @@ func IsTenancy(host string) bool {
 	return strings.HasSuffix(normalizedHost, "."+tenancyHost)
 }
 
+// NormalizeHostname ensures the host matches the values used throughout
+// the rest of the codebase with respect to hostnames. These are github,
+// localhost, and tenancyHost.
 func NormalizeHostname(host string) string {
 	hostname := strings.ToLower(host)
 	if strings.HasSuffix(hostname, "."+github) {