Fix comments

arcalot · Nov 14, 2024 · 21b8caf · 21b8caf
1 parent 94462c2
commit 21b8caf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/schema/enum_string_test.go b/schema/enum_string_test.go
@@ -82,7 +82,7 @@ func TestStringEnumSerialization(t *testing.T) {
 
 func TestStringEnumTypedSerialization(t *testing.T) {
 	// In this test a typed enum is being inputted into Serialize, but
-	// it is not using a typed
+	// it is not using a typed enum schema.
 	type Size string
 	s := schema.NewStringEnumSchema(map[string]*schema.DisplayValue{
 		"small": {NameValue: schema.PointerTo("Small")},

diff --git a/schema/string.go b/schema/string.go
@@ -17,6 +17,9 @@ type String interface {
 }
 
 // NewStringSchema creates a new string schema.
+// If the corresponding Golang type is not a string, but a type
+// defined from a string (example `type NameOfType string`), use
+// `NewTypedStringEnumSchema` instead.
 func NewStringSchema(minLen *int64, maxLen *int64, pattern *regexp.Regexp) *StringSchema {
 	return &StringSchema{
 		MinValue:     minLen,