Document newly exported functions

cli · Apr 10, 2024 · 8d04841 · 8d04841
1 parent 7b29c8e
commit 8d04841
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/pkg/auth/auth.go b/pkg/auth/auth.go
@@ -152,11 +152,15 @@ func defaultHost(cfg *config.Config) (string, string) {
 // TenancyHost is the domain name of a tenancy GitHub instance.
 const tenancyHost = "ghe.com"
 
+// IsEnterprise determines if a provided host is a GitHub Enterprise Server instance,
+// rather than GitHub.com or a tenancy GitHub instance.
 func IsEnterprise(host string) bool {
 	normalizedHost := normalizeHostname(host)
 	return normalizedHost != github && normalizedHost != localhost && !IsTenancy(normalizedHost)
 }
 
+// IsTenancy determines if a provided host is a tenancy GitHub instance,
+// rather than GitHub.com or a GitHub Enterprise Server instance.
 func IsTenancy(host string) bool {
 	normalizedHost := normalizeHostname(host)
 	return strings.HasSuffix(normalizedHost, "."+tenancyHost)