chore: complete unfinished documentation for keyformat.NewKeyFormat

oeuvrev · May 13, 2023 · bdf3630 · bdf3630
1 parent 829de96
commit bdf3630
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/keyformat/key_format.go b/keyformat/key_format.go
@@ -30,7 +30,9 @@ type KeyFormat struct {
 //		return keyFormat.Key(version, hasher.Sum(nil))
 //	}
 //
-// if the last term of the layout ends in 0
+// If the last term of the layout is 0 it is unbounded, and will accept any length.
+//
+// NewKeyFormat panics if any other term than the last is 0.
 func NewKeyFormat(prefix byte, layout ...int) *KeyFormat {
 	// For prefix byte
 	length := 1