Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert support for module-relative documentation extension links #574

Merged
merged 1 commit into from
Apr 28, 2023
Merged

Revert support for module-relative documentation extension links #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions Sources/SwiftDocC/Infrastructure/DocumentationContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,18 +1335,9 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
}

if LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver {
// If there's a single module then resolve relative to the module symbol. Otherwise resolve relative to the bundle root.
// This means that links can omit the module name if there's only one module but need to start with the module name if there are multiple modules.
let rootReference: ResolvedTopicReference
let moduleReferences = hierarchyBasedLinkResolver!.modules()
if moduleReferences.count == 1 {
rootReference = moduleReferences.first!
} else {
rootReference = bundle.rootReference
}

// FIXME: Resolve the link relative to the module https://github.com/apple/swift-docc/issues/516
let reference = TopicReference.unresolved(.init(topicURL: url))
switch resolve(reference, in: rootReference, fromSymbolLink: true) {
switch resolve(reference, in: bundle.rootReference, fromSymbolLink: true) {
case .success(let resolved):
if let existing = uncuratedDocumentationExtensions[resolved] {
if symbolsWithMultipleDocumentationExtensionMatches[resolved] == nil {
Expand Down
45 changes: 0 additions & 45 deletions Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3040,51 +3040,6 @@ let expected = """
}
}

func testMatchesDocumentationExtensionsRelativeToModule() throws {
try XCTSkipUnless(LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver)

let (_, bundle, context) = try testBundleAndContext(copying: "MixedLanguageFrameworkWithLanguageRefinements") { url in
// Top level symbols, omitting the module name
try """
# ``MyStruct/myStructProperty``
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
my struct property
""".write(to: url.appendingPathComponent("struct-property.md"), atomically: true, encoding: .utf8)

try """
# ``MyTypeAlias``
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
my type alias
""".write(to: url.appendingPathComponent("alias.md"), atomically: true, encoding: .utf8)
}

do {
// The resolved reference needs more disambiguation than the documentation extension link did.
let reference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MixedFramework/MyStruct/myStructProperty", sourceLanguage: .swift)

let node = try context.entity(with: reference)
let symbol = try XCTUnwrap(node.semantic as? Symbol)
XCTAssertEqual(symbol.abstract?.plainText, "my struct property", "The abstract should be from the overriding documentation extension.")
}

do {
// The resolved reference needs more disambiguation than the documentation extension link did.
let reference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MixedFramework/MyTypeAlias", sourceLanguage: .swift)

let node = try context.entity(with: reference)
let symbol = try XCTUnwrap(node.semantic as? Symbol)
XCTAssertEqual(symbol.abstract?.plainText, "my type alias", "The abstract should be from the overriding documentation extension.")
}
}

func testMultipleDocumentationExtensionMatchDiagnostic() throws {
try XCTSkipUnless(LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver)

Expand Down