slight doc comment tweak

agentstation · Sep 15, 2024 · 44a1ee0 · 44a1ee0
1 parent c79f378
commit 44a1ee0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -115,7 +115,7 @@ type Key string
 func Encode(uuid string) (Key, error)
 ```
 
-Encode will encode a given UUID string into a Key with basic validation.
+Encode will encode a given UUID string into a Key with basic length validation.
 
 <a name="FromString"></a>
 ### func [FromString](<https://github.com/agentstation/uuidkey/blob/master/uuidkey.go#L24>)

diff --git a/codec.go b/codec.go
@@ -23,7 +23,7 @@ func decode(s string) string {
 	return (strings.Repeat("0", padding) + decoded)
 }
 
-// Encode will encode a given UUID string into a Key with basic validation.
+// Encode will encode a given UUID string into a Key with basic length validation.
 func Encode(uuid string) (Key, error) {
 	if len(uuid) != 36 { // check the UUID string has the correct length
 		return "", fmt.Errorf("invalid UUID length: expected 36 characters, got %d", len(uuid))