Add comment to new exported function

jtmcg · jtmcg · commit 6a5df44c660c · 2024-10-14T11:57:22.000-07:00
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) {

Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,9 @@ func IsTenancy(host string) bool {`
`165`	`165`	`return strings.HasSuffix(normalizedHost, "."+tenancyHost)`
`166`	`166`	`}`
`167`	`167`
	`168`	`+// NormalizeHostname ensures the host matches the values used throughout`
	`169`	`+// the rest of the codebase with respect to hostnames. These are github,`
	`170`	`+// localhost, and tenancyHost.`
`168`	`171`	`func NormalizeHostname(host string) string {`
`169`	`172`	`hostname := strings.ToLower(host)`
`170`	`173`	`if strings.HasSuffix(hostname, "."+github) {`