Skip to content

Commit be0a6bf

Browse files
authored
Remove deprecated path properties (#372)
1 parent 751f06d commit be0a6bf

File tree

2 files changed

+0
-25
lines changed

2 files changed

+0
-25
lines changed

Sources/SwiftDocC/LinkTargets/LinkDestinationSummary.swift

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,6 @@ public struct LinkDestinationSummary: Codable, Equatable {
8080
/// The language of the summarized element.
8181
public let language: SourceLanguage
8282

83-
/// The relative path to this element.
84-
///
85-
/// > Note: For elements representing on-page elements, this value will include a fragment component.
86-
@available(*, deprecated, message: "Use 'relativePresentationURL' instead.")
87-
public var path: String {
88-
return relativePresentationURL.absoluteString
89-
}
90-
9183
/// The relative presentation URL for this element.
9284
public let relativePresentationURL: URL
9385

@@ -171,12 +163,6 @@ public struct LinkDestinationSummary: Codable, Equatable {
171163
/// The source language of the variant or `nil` if the kind is the same as the summarized element.
172164
public let language: VariantValue<SourceLanguage>
173165

174-
/// The relative path of the variant or `nil` if the relative is the same as the summarized element.
175-
@available(*, deprecated, message: "Use 'relativePresentationURL' instead.")
176-
public var path: VariantValue<String> {
177-
return relativePresentationURL?.absoluteString
178-
}
179-
180166
/// The relative presentation URL of the variant or `nil` if the relative is the same as the summarized element.
181167
public let relativePresentationURL: VariantValue<URL>
182168

Tests/SwiftDocCTests/LinkTargets/LinkDestinationSummaryTests.swift

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ class ExternalLinkableTests: XCTestCase {
110110
let summaries = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)
111111
let pageSummary = summaries[0]
112112
XCTAssertEqual(pageSummary.title, "Basic Augmented Reality App 💻")
113-
XCTAssertEqual(pageSummary.path, "/tutorials/testbundle/tutorial")
114113
XCTAssertEqual(pageSummary.relativePresentationURL.absoluteString, "/tutorials/testbundle/tutorial")
115114
XCTAssertEqual(pageSummary.referenceURL.absoluteString, "doc://com.test.example/tutorials/TestBundle/Tutorial")
116115
XCTAssertEqual(pageSummary.language, .swift)
@@ -129,7 +128,6 @@ class ExternalLinkableTests: XCTestCase {
129128

130129
let sectionSummary = summaries[1]
131130
XCTAssertEqual(sectionSummary.title, "Create a New AR Project 💻")
132-
XCTAssertEqual(sectionSummary.path, "/tutorials/testbundle/tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
133131
XCTAssertEqual(sectionSummary.relativePresentationURL.absoluteString, "/tutorials/testbundle/tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
134132
XCTAssertEqual(sectionSummary.referenceURL.absoluteString, "doc://com.test.example/tutorials/TestBundle/Tutorial#Create-a-New-AR-Project-%F0%9F%92%BB")
135133
XCTAssertEqual(sectionSummary.language, .swift)
@@ -164,7 +162,6 @@ class ExternalLinkableTests: XCTestCase {
164162
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
165163

166164
XCTAssertEqual(summary.title, "MyClass")
167-
XCTAssertEqual(summary.path, "/documentation/mykit/myclass")
168165
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myclass")
169166
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyClass")
170167
XCTAssertEqual(summary.language, .swift)
@@ -203,7 +200,6 @@ class ExternalLinkableTests: XCTestCase {
203200
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
204201

205202
XCTAssertEqual(summary.title, "MyProtocol")
206-
XCTAssertEqual(summary.path, "/documentation/mykit/myprotocol")
207203
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myprotocol")
208204
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyProtocol")
209205
XCTAssertEqual(summary.language, .swift)
@@ -239,7 +235,6 @@ class ExternalLinkableTests: XCTestCase {
239235
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
240236

241237
XCTAssertEqual(summary.title, "myFunction()")
242-
XCTAssertEqual(summary.path, "/documentation/mykit/myclass/myfunction()")
243238
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/myclass/myfunction()")
244239
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/MyClass/myFunction()")
245240
XCTAssertEqual(summary.language, .swift)
@@ -259,7 +254,6 @@ class ExternalLinkableTests: XCTestCase {
259254
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
260255

261256
XCTAssertEqual(summary.title, "globalFunction(_:considering:)")
262-
XCTAssertEqual(summary.path, "/documentation/mykit/globalfunction(_:considering:)")
263257
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/globalfunction(_:considering:)")
264258
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/globalFunction(_:considering:)")
265259
XCTAssertEqual(summary.language, .swift)
@@ -297,7 +291,6 @@ class ExternalLinkableTests: XCTestCase {
297291
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
298292

299293
XCTAssertEqual(summary.title, "Bar")
300-
XCTAssertEqual(summary.path, "/documentation/mixedlanguageframework/bar")
301294
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar")
302295
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.MixedLanguageFramework/documentation/MixedLanguageFramework/Bar")
303296
XCTAssertEqual(summary.language, .swift)
@@ -337,7 +330,6 @@ class ExternalLinkableTests: XCTestCase {
337330
// Check variant content that is the same as the summarized element
338331
XCTAssertEqual(variant.title, nil)
339332
XCTAssertEqual(variant.abstract, nil)
340-
XCTAssertEqual(variant.path, nil)
341333
XCTAssertEqual(variant.usr, nil)
342334
XCTAssertEqual(variant.kind, nil)
343335
XCTAssertEqual(variant.taskGroups, nil)
@@ -351,7 +343,6 @@ class ExternalLinkableTests: XCTestCase {
351343
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
352344

353345
XCTAssertEqual(summary.title, "myStringFunction(_:)")
354-
XCTAssertEqual(summary.path, "/documentation/mixedlanguageframework/bar/mystringfunction(_:)")
355346
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar/mystringfunction(_:)")
356347
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.MixedLanguageFramework/documentation/MixedLanguageFramework/Bar/myStringFunction(_:)")
357348
XCTAssertEqual(summary.language, .swift)
@@ -405,7 +396,6 @@ class ExternalLinkableTests: XCTestCase {
405396

406397
// Check variant content that is the same as the summarized element
407398
XCTAssertEqual(variant.abstract, nil)
408-
XCTAssertEqual(variant.path, nil)
409399
XCTAssertEqual(variant.usr, nil)
410400
XCTAssertEqual(variant.kind, nil)
411401
XCTAssertEqual(
@@ -474,7 +464,6 @@ class ExternalLinkableTests: XCTestCase {
474464
XCTAssertEqual(decoded.kind, .class)
475465
XCTAssertEqual(decoded.title, "ClassName")
476466
XCTAssertEqual(decoded.abstract?.plainText, "A brief explanation of my class.")
477-
XCTAssertEqual(decoded.path, "documentation/MyKit/ClassName")
478467
XCTAssertEqual(decoded.relativePresentationURL.absoluteString, "documentation/MyKit/ClassName")
479468
XCTAssertEqual(decoded.declarationFragments, [
480469
.init(text: "class", kind: .keyword, identifier: nil),

0 commit comments

Comments
 (0)