update DocumentationInheritance test expectations

tayloraswift · tayloraswift · commit b0a2365579fe · 2025-05-11T20:45:08.000Z
diff --git a/Sources/SymbolGraphPartTests/DocumentationInheritance.swift b/Sources/SymbolGraphPartTests/DocumentationInheritance.swift
@@ -132,36 +132,42 @@ struct DocumentationInheritance
                 .intrinsicWitness(.init(
                     _ : "s24DocumentationInheritance15OtherRefinementPAAE8protocolytvp",
                     of: "s24DocumentationInheritance8ProtocolP8protocolytvp",
-                    origin: .init("s24DocumentationInheritance8ProtocolP8protocolytvp"))),
+                    origin: "s24DocumentationInheritance8ProtocolP8protocolytvp")),
+
+                .requirement(.init(
+                    _ : "s24DocumentationInheritance10RefinementP8protocolytvp",
+                    of: "s24DocumentationInheritance10RefinementP",
+                    origin: "s24DocumentationInheritance8ProtocolP8protocolytvp")),
+
+                .override(.init(
+                    _ : "s24DocumentationInheritance10RefinementP8protocolytvp",
+                    of: "s24DocumentationInheritance8ProtocolP8protocolytvp",
+                    origin: "s24DocumentationInheritance8ProtocolP8protocolytvp")),
 
                 .member(.init(
                     _ : "s24DocumentationInheritance9ConformerV7nowhereytvp",
                     in: .scalar("s24DocumentationInheritance9ConformerV"),
-                    origin: .init("s24DocumentationInheritance10RefinementP7nowhereytvp"))),
+                    origin: "s24DocumentationInheritance10RefinementP7nowhereytvp")),
 
                 .member(.init(
                     _ : "s24DocumentationInheritance9ConformerV10refinementytvp",
                     in: .scalar(.init("s:24DocumentationInheritance9ConformerV")!),
-                    origin: .init(.init(
-                        "s:24DocumentationInheritance10RefinementP10refinementytvp")!))),
+                    origin: "s24DocumentationInheritance10RefinementP10refinementytvp")),
 
                 .member(.init(
                     _ : "s24DocumentationInheritance9ConformerV9conformerytvp",
                     in: .scalar("s24DocumentationInheritance9ConformerV"),
-                    origin: .init(
-                        "s24DocumentationInheritance10RefinementP9conformerytvp"))),
+                    origin: "s24DocumentationInheritance10RefinementP9conformerytvp")),
 
                 .member(.init(
                     _ : "s24DocumentationInheritance9ConformerV10everywhereytvp",
                     in: .scalar("s24DocumentationInheritance9ConformerV"),
-                    origin: .init(
-                        "s24DocumentationInheritance10RefinementP10everywhereytvp"))),
+                    origin: "s24DocumentationInheritance10RefinementP10everywhereytvp")),
 
                 .member(.init(
                     _ : "s24DocumentationInheritance9ConformerV8protocolytvp",
                     in: .scalar("s24DocumentationInheritance9ConformerV"),
-                    origin: .init(
-                        "s24DocumentationInheritance8ProtocolP8protocolytvp"))),
+                    origin: "s24DocumentationInheritance8ProtocolP8protocolytvp")),
             ])
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.AnyRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.AnyRelationship.swift
@@ -16,21 +16,39 @@ extension Symbol
         case requirement            (RequirementRelationship)
     }
 }
+extension Symbol.AnyRelationship:CustomStringConvertible
+{
+    public
+    var description:String
+    {
+        switch self
+        {
+        case .conformance       (let self): self.description
+        case .intrinsicWitness  (let self): self.description
+        case .extension         (let self): self.description
+        case .inheritance       (let self): self.description
+        case .feature           (let self): self.description
+        case .member            (let self): self.description
+        case .override          (let self): self.description
+        case .requirement       (let self): self.description
+        }
+    }
+}
 extension Symbol.AnyRelationship
 {
     @inlinable public
     var existential:any SymbolRelationship
     {
         switch self
         {
-        case .conformance           (let relationship): relationship
-        case .intrinsicWitness      (let relationship): relationship
-        case .extension             (let relationship): relationship
-        case .inheritance           (let relationship): relationship
-        case .feature               (let relationship): relationship
-        case .member                (let relationship): relationship
-        case .override              (let relationship): relationship
-        case .requirement           (let relationship): relationship
+        case .conformance       (let self): self
+        case .intrinsicWitness  (let self): self
+        case .extension         (let self): self
+        case .inheritance       (let self): self
+        case .feature           (let self): self
+        case .member            (let self): self
+        case .override          (let self): self
+        case .requirement       (let self): self
         }
     }
 
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.ConformanceRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.ConformanceRelationship.swift
@@ -34,7 +34,8 @@ extension Symbol.ConformanceRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (conformance: \(self.source), to: \(self.target))
+        /\(self.source) CONFORMS TO \(self.target) \
+        (\(self.conditions.count) condition(s), \(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.ExtensionRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.ExtensionRelationship.swift
@@ -29,7 +29,7 @@ extension Symbol.ExtensionRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (extension: \(self.source), of: \(self.target))
+        /\(self.source) EXTENDS \(self.target)/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.FeatureRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.FeatureRelationship.swift
@@ -29,7 +29,7 @@ extension Symbol.FeatureRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (feature: \(self.source), of: \(self.target))
+        /\(self.source) INHERITED BY \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.InheritanceRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.InheritanceRelationship.swift
@@ -55,7 +55,7 @@ extension Symbol.InheritanceRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (inheritance by: \(self.source), of: \(self.target))
+        /\(self.source) INHERITS FROM \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.IntrinsicWitnessRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.IntrinsicWitnessRelationship.swift
@@ -57,7 +57,7 @@ extension Symbol.IntrinsicWitnessRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (default implementation: \(self.source), of: \(self.target))
+        /\(self.source) IMPLEMENTS \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.MemberRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.MemberRelationship.swift
@@ -57,7 +57,7 @@ extension Symbol.MemberRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (member: \(self.source), of: \(self.target))
+        /\(self.source) MEMBER OF \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.OverrideRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.OverrideRelationship.swift
@@ -58,7 +58,7 @@ extension Symbol.OverrideRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (override: \(self.source), of: \(self.target))
+        /\(self.source) OVERRIDES \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/
         """
     }
 }
diff --git a/Sources/SymbolGraphParts/Relationships/Symbol.RequirementRelationship.swift b/Sources/SymbolGraphParts/Relationships/Symbol.RequirementRelationship.swift
@@ -14,6 +14,7 @@ extension Symbol
         public
         let optional:Bool
 
+        @inlinable public
         init(_ source:Symbol.Decl,
             of target:Symbol.Decl,
             origin:Symbol.Decl? = nil,
@@ -65,7 +66,8 @@ extension Symbol.RequirementRelationship:CustomStringConvertible
     var description:String
     {
         """
-        (\(self.optional ? "optional " : "")requirement: \(self.source), of: \(self.target))
+        /\(self.source) REQUIRED BY \(self.target) \
+        (\(self.origin == nil ? 0 : 1) origin(s), optional: \(self.optional))/
         """
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ extension Symbol.ConformanceRelationship:CustomStringConvertible`
`34`	`34`	`var description:String`
`35`	`35`	`{`
`36`	`36`	`"""`
`37`		`- (conformance: \(self.source), to: \(self.target))`
	`37`	`+ /\(self.source) CONFORMS TO \(self.target) \`
	`38`	`+ (\(self.conditions.count) condition(s), \(self.origin == nil ? 0 : 1) origin(s))/`
`38`	`39`	`"""`
`39`	`40`	`}`
`40`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ extension Symbol.ExtensionRelationship:CustomStringConvertible`
`29`	`29`	`var description:String`
`30`	`30`	`{`
`31`	`31`	`"""`
`32`		`- (extension: \(self.source), of: \(self.target))`
	`32`	`+ /\(self.source) EXTENDS \(self.target)/`
`33`	`33`	`"""`
`34`	`34`	`}`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ extension Symbol.FeatureRelationship:CustomStringConvertible`
`29`	`29`	`var description:String`
`30`	`30`	`{`
`31`	`31`	`"""`
`32`		`- (feature: \(self.source), of: \(self.target))`
	`32`	`+ /\(self.source) INHERITED BY \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/`
`33`	`33`	`"""`
`34`	`34`	`}`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ extension Symbol.InheritanceRelationship:CustomStringConvertible`
`55`	`55`	`var description:String`
`56`	`56`	`{`
`57`	`57`	`"""`
`58`		`- (inheritance by: \(self.source), of: \(self.target))`
	`58`	`+ /\(self.source) INHERITS FROM \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/`
`59`	`59`	`"""`
`60`	`60`	`}`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ extension Symbol.IntrinsicWitnessRelationship:CustomStringConvertible`
`57`	`57`	`var description:String`
`58`	`58`	`{`
`59`	`59`	`"""`
`60`		`- (default implementation: \(self.source), of: \(self.target))`
	`60`	`+ /\(self.source) IMPLEMENTS \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/`
`61`	`61`	`"""`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ extension Symbol.MemberRelationship:CustomStringConvertible`
`57`	`57`	`var description:String`
`58`	`58`	`{`
`59`	`59`	`"""`
`60`		`- (member: \(self.source), of: \(self.target))`
	`60`	`+ /\(self.source) MEMBER OF \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/`
`61`	`61`	`"""`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ extension Symbol.OverrideRelationship:CustomStringConvertible`
`58`	`58`	`var description:String`
`59`	`59`	`{`
`60`	`60`	`"""`
`61`		`- (override: \(self.source), of: \(self.target))`
	`61`	`+ /\(self.source) OVERRIDES \(self.target) (\(self.origin == nil ? 0 : 1) origin(s))/`
`62`	`62`	`"""`
`63`	`63`	`}`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ extension Symbol`
`14`	`14`	`public`
`15`	`15`	`let optional:Bool`
`16`	`16`
	`17`	`+ @inlinable public`
`17`	`18`	`init(_ source:Symbol.Decl,`
`18`	`19`	`of target:Symbol.Decl,`
`19`	`20`	`origin:Symbol.Decl? = nil,`
`@@ -65,7 +66,8 @@ extension Symbol.RequirementRelationship:CustomStringConvertible`
`65`	`66`	`var description:String`
`66`	`67`	`{`
`67`	`68`	`"""`
`68`		`- (\(self.optional ? "optional " : "")requirement: \(self.source), of: \(self.target))`
	`69`	`+ /\(self.source) REQUIRED BY \(self.target) \`
	`70`	`+ (\(self.origin == nil ? 0 : 1) origin(s), optional: \(self.optional))/`
`69`	`71`	`"""`
`70`	`72`	`}`
`71`	`73`	`}`