Browse Source

x/model: doc rule of thumb about valid vs. invalid Names

Blake Mizerany 1 year ago
parent
commit
ad6f020bd8
1 changed files with 6 additions and 0 deletions
  1. 6 0
      x/model/name.go

+ 6 - 0
x/model/name.go

@@ -92,6 +92,12 @@ type Name struct {
 //	"example.com/mistral:7b+Q4_0+"
 //	"x/y/z/z:8n+I"
 //	""
+//
+// It returns the zero value if any part is invalid.
+//
+// As a rule of thumb, an valid name is one that can be round-tripped with
+// the [Name.String] method. That means ("x+") is invalid because
+// [Name.String] will not print a "+" if the build is empty.
 func ParseName(s string) Name {
 	var r Name
 	for kind, part := range NameParts(s) {