Improve comments from self-review

kylecarbs · kylecarbs · commit e6619ffba1ac · 2022-07-31T19:33:47.000Z
diff --git a/coderd/userauth.go b/coderd/userauth.go
@@ -214,7 +214,7 @@ type OIDCConfig struct {
 	httpmw.OAuth2Config
 
 	Verifier *oidc.IDTokenVerifier
-	// EmailDomain is an optional domain to require when authenticating.
+	// EmailDomain is the domain to enforce when a user authenticates.
 	EmailDomain  string
 	AllowSignups bool
 }
diff --git a/coderd/username/username.go b/coderd/username/username.go
@@ -12,7 +12,7 @@ var (
 	replace = regexp.MustCompile("[^a-zA-Z0-9-]*")
 )
 
-// Valid returns whether the input string is a valid username or not.
+// Valid returns whether the input string is a valid username.
 func Valid(str string) bool {
 	if len(str) > 32 {
 		return false

Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ type OIDCConfig struct {`
`214`	`214`	`httpmw.OAuth2Config`
`215`	`215`
`216`	`216`	`Verifier *oidc.IDTokenVerifier`
`217`		`- // EmailDomain is an optional domain to require when authenticating.`
	`217`	`+ // EmailDomain is the domain to enforce when a user authenticates.`
`218`	`218`	`EmailDomain string`
`219`	`219`	`AllowSignups bool`
`220`	`220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ var (`
`12`	`12`	`replace = regexp.MustCompile("[^a-zA-Z0-9-]*")`
`13`	`13`	`)`
`14`	`14`
`15`		`-// Valid returns whether the input string is a valid username or not.`
	`15`	`+// Valid returns whether the input string is a valid username.`
`16`	`16`	`func Valid(str string) bool {`
`17`	`17`	`if len(str) > 32 {`
`18`	`18`	`return false`