add more clarifying comments

onflow · Nov 30, 2022 · 75b9cda · 75b9cda
1 parent 3b037e2
commit 75b9cda
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/runtime/sema/type.go b/runtime/sema/type.go
@@ -3606,6 +3606,8 @@ func (t *CompositeType) IsResourceType() bool {
 	return t.Kind == common.CompositeKindResource ||
 		// attachments are always the same kind as their base type
 		(t.Kind == common.CompositeKindAttachment &&
+			// this check is necessary to prevent `attachment A for A {}`
+			// from causing an infinite recursion case here
 			t.baseType != t &&
 			t.baseType.IsResourceType())
 }

diff --git a/runtime/sema/typeannotationstate.go b/runtime/sema/typeannotationstate.go
@@ -25,7 +25,11 @@ type TypeAnnotationState uint
 const (
 	TypeAnnotationStateUnknown TypeAnnotationState = iota
 	TypeAnnotationStateValid
+	// Resource annotations (@) are invalid on non-resource types (e.g. @Int)
 	TypeAnnotationStateInvalidResourceAnnotation
+	// Resource types must have a resource annotation (@)
 	TypeAnnotationStateMissingResourceAnnotation
+	// attachments types must never appear directly as annotations, and instead
+	// should appear only in reference types: e.g. `&A` or `[&A]`
 	TypeAnnotationStateDirectAttachmentTypeAnnotation
 )