adding some docstrings

Author: Jusshersmith

internal/pkg/options/email_address_validator.go

@@ -18,6 +18,14 @@ type EmailAddressValidator struct {
 	AllowedEmails []string
 }
 
+// NewEmailAddressValidator takes in a list of email addresses and returns a Validator object.
+// The validator can be used to validate that the session.Email:
+// - is non-empty
+// - matches one of the originally passed in email addresses
+//   (case insensitive)
+// - if the originally passed in list of emails consists only of "*", then all emails
+//   are considered valid based on their domain.
+// If valid, nil is returned in place of an error.
 func NewEmailAddressValidator(allowedEmails []string) EmailAddressValidator {
 	var emailAddresses []string
 

internal/pkg/options/email_domain_validator.go

@@ -16,6 +16,14 @@ type EmailDomainValidator struct {
 	AllowedDomains []string
 }
 
+// NewEmailDomainValidator takes in a list of domains and returns a Validator object.
+// The validator can be used to validate that the session.Email:
+// - is non-empty
+// - the domain of the email address matches one of the originally passed in domains.
+//   (case insensitive)
+// - if the originally passed in list of domains consists only of "*", then all emails
+//   are considered valid based on their domain.
+// If valid, nil is returned in place of an error.
 func NewEmailDomainValidator(allowedDomains []string) *EmailDomainValidator {
 	emailDomains := make([]string, 0, len(allowedDomains))
 

internal/pkg/options/email_group_validator.go

@@ -18,6 +18,12 @@ type EmailGroupValidator struct {
 	AllowedGroups []string
 }
 
+// NewEmailGroupValidator takes in a Provider object and a list of groups, and returns a Validator object.
+// The validator can be used to validate that the session.Email:
+// - if an empty list is passed in in place of a list of groups, all session.Emails will be considered valid
+//   regardless of group membership with that particular Provider.
+// - according to the Provider that was passed in, is a member of one of the originally passed in groups.
+// If valid, nil is returned in place of an error.
 func NewEmailGroupValidator(provider providers.Provider, allowedGroups []string) EmailGroupValidator {
 	return EmailGroupValidator{
 		Provider:      provider,