From 6a5df44c660cef845574762183f14c3435615855 Mon Sep 17 00:00:00 2001
From: Tyler McGoffin <jtmcg@github.com>
Date: Mon, 14 Oct 2024 11:57:22 -0700
Subject: [PATCH] Add comment to new exported function

---
 pkg/auth/auth.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pkg/auth/auth.go b/pkg/auth/auth.go
index 9e535f4..8338fea 100644
--- 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) {