Rename the documentation coverage header 'usr' to 'Reference Path' (#1184)

Author: sofiadinizms

Sources/SwiftDocC/Infrastructure/CoverageDataEntry.swift

@@ -15,7 +15,7 @@ import SymbolKit
 public struct CoverageDataEntry: CustomStringConvertible, Codable {
     internal init(
         title: String,
-        usr: String,
+        referencePath: String,
         sourceLanguage: SourceLanguage,
         availableSourceLanguages: Set<SourceLanguage>,
         kind: DocumentationNode.Kind,
@@ -26,7 +26,7 @@ public struct CoverageDataEntry: CustomStringConvertible, Codable {
         kindSpecificData: KindSpecificData?
     ) {
         self.title = title
-        self.usr = usr
+        self.referencePath = referencePath
         self.sourceLanguage = sourceLanguage
         self.kind = kind
         self.hasAbstract = hasAbstract
@@ -38,7 +38,7 @@ public struct CoverageDataEntry: CustomStringConvertible, Codable {
     }
 
     internal var title: String
-    internal var usr: String
+    internal var referencePath: String
 
     internal var hasAbstract: Bool
     internal var isCurated: Bool
@@ -74,7 +74,7 @@ public struct CoverageDataEntry: CustomStringConvertible, Codable {
             ("Code Listing?", 15, \.hasCodeListing.description),
             ("Parameters", 12, it),
             ("Language", 15, \.sourceLanguage.name),
-            ("USR", 0, \.usr),
+            ("Reference Path", 0, \.referencePath),
         ]
 
     }()
@@ -194,15 +194,15 @@ extension CoverageDataEntry {
         let hasAbstract = semanticSymbol?.abstractSection != nil  // How should we this handle 'possible' failure?
         let isCurated =
             context.manuallyCuratedReferences?.contains(documentationNode.reference) ?? false
-        let usr = renderNode.identifier.description
+        let referencePath = renderNode.identifier.description
         let sourceLanguage = documentationNode.sourceLanguage
         let availableSourceLanguages = documentationNode.availableSourceLanguages
         let availability = semanticSymbol?.availability
         let hasCodeListing = renderNode.hasCodeListing
 
         self = try CoverageDataEntry(
             title: title.description,
-            usr: usr,
+            referencePath: referencePath,
             sourceLanguage: sourceLanguage,
             availableSourceLanguages: availableSourceLanguages,
             kind: kind,

Tests/SwiftDocCTests/Coverage/CoverageDetailedOutputTests.swift

@@ -27,7 +27,7 @@ Members         | (0/0)           | (0/0)           | (0/0)
 Globals         | (0/0)           | (0/0)           | (0/0)
 
 
-Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          USR
+Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          Reference Path
 --No Symbols to display--
 
 """
@@ -38,7 +38,7 @@ Symbol Name                      Kind                             Abstract?
         let source: [CoverageDataEntry] = [
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClass",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .class,
@@ -61,7 +61,7 @@ Members         | (0/0)           | (0/0)           | (0/0)
 Globals         | (0/0)           | (0/0)           | (0/0)
 
 
-Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          USR
+Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          Reference Path
 MyDocumentedUncuratedClass     | Class                          | true         | false        | false           | -            | Swift           | doc://org.swift.docc.example/documentation/MyLibrary/MyClass
 
 """
@@ -72,7 +72,7 @@ MyDocumentedUncuratedClass     | Class                          | true         |
         let source: [CoverageDataEntry] = [
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClass",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .class,
@@ -83,7 +83,7 @@ MyDocumentedUncuratedClass     | Class                          | true         |
                 kindSpecificData: .class(memberStats: [:])),
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClassProperty",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .instanceProperty,
@@ -100,7 +100,7 @@ MyDocumentedUncuratedClass     | Class                          | true         |
             shouldGenerateDetailed: true
         )
         let expected = """
-Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          USR
+Symbol Name                      Kind                             Abstract?      Curated?       Code Listing?     Parameters     Language          Reference Path
 MyDocumentedUncuratedClass     | Class                          | true         | false        | true            | -            | Swift           | doc://org.swift.docc.example/documentation/MyLibrary/MyClass
 MyDocumentedUncuratedClassProp | Instance Property              | false        | true         | false           | -            | Swift           | doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty
 

Tests/SwiftDocCTests/Coverage/CoverageSummaryTests.swift

@@ -45,7 +45,7 @@ Globals         | (0/0)           | (0/0)           | (0/0)
         let source: [CoverageDataEntry] = [
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClass",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .class,
@@ -75,7 +75,7 @@ Globals         | (0/0)           | (0/0)           | (0/0)
         let source: [CoverageDataEntry] = [
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClass",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .class,
@@ -86,7 +86,7 @@ Globals         | (0/0)           | (0/0)           | (0/0)
                 kindSpecificData: .class(memberStats: [:])),
             CoverageDataEntry(
                 title: "MyDocumentedUncuratedClassProperty",
-                usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty",
+                referencePath: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty",
                 sourceLanguage: .swift,
                 availableSourceLanguages: [.swift],
                 kind: .instanceProperty,