From 39731c240281cdbc7194d9c4810e59ba8272611b Mon Sep 17 00:00:00 2001 From: Victoria Mitchell Date: Wed, 14 Dec 2022 17:21:55 -0700 Subject: [PATCH] add issue link in fixme comments --- .../Rendering/Symbol/AvailabilityRenderMetadataItem.swift | 2 +- .../Semantics/MetadataAvailabilityTests.swift | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift b/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift index 8486a2db9b..ab03a06fb7 100644 --- a/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift +++ b/Sources/SwiftDocC/Model/Rendering/Symbol/AvailabilityRenderMetadataItem.swift @@ -143,7 +143,7 @@ public struct AvailabilityRenderItem: Codable, Hashable, Equatable { init?(_ availability: MetadataAvailability, current: PlatformVersion?) { if availability.introduced == nil { // FIXME: Deprecated/Beta markings need platform versions to display properly in Swift-DocC-Render (rdar://56897597) - // Fill in the appropriate values here when that's fixed (issue link forthcoming) + // Fill in the appropriate values here when that's fixed (https://github.com/apple/swift-docc/issues/441) return nil } diff --git a/Tests/SwiftDocCTests/Semantics/MetadataAvailabilityTests.swift b/Tests/SwiftDocCTests/Semantics/MetadataAvailabilityTests.swift index 1cf32606cb..bffa53d4a9 100644 --- a/Tests/SwiftDocCTests/Semantics/MetadataAvailabilityTests.swift +++ b/Tests/SwiftDocCTests/Semantics/MetadataAvailabilityTests.swift @@ -89,7 +89,7 @@ class MetadataAvailabilityTests: XCTestCase { } func testInvalidDuplicateBeta() throws { - throw XCTSkip("FIXME: isBeta is unused (issue link forthcoming)") + throw XCTSkip("FIXME: isBeta is unused (https://github.com/apple/swift-docc/issues/441)") // func assertInvalidDirective(source: String) throws { // let document = Document(parsing: source, options: .parseBlockDirectives) @@ -129,7 +129,7 @@ class MetadataAvailabilityTests: XCTestCase { } func testInvalidDuplicateDeprecated() throws { - throw XCTSkip("FIXME: isDeprecated is unused (issue link forthcoming)") + throw XCTSkip("FIXME: isDeprecated is unused (https://github.com/apple/swift-docc/issues/441)") // func assertInvalidDirective(source: String) throws { // let document = Document(parsing: source, options: .parseBlockDirectives) @@ -171,7 +171,7 @@ class MetadataAvailabilityTests: XCTestCase { func testValidDirective() throws { // assemble all the combinations of arguments you could give let validArguments: [String] = [ - // FIXME: isBeta and isDeprecated are unused (issue link forthcoming) + // FIXME: isBeta and isDeprecated are unused (https://github.com/apple/swift-docc/issues/441) // "isBeta: true", // "isDeprecated: true", // "isBeta: true, isDeprecated: true", @@ -200,7 +200,7 @@ class MetadataAvailabilityTests: XCTestCase { } // basic validity test for giving several directives - // FIXME: re-add isBeta after that is implemented (issue link forthcoming) + // FIXME: re-add isBeta after that is implemented (https://github.com/apple/swift-docc/issues/441) let source = """ @Metadata { @Available(macOS, introduced: "11.0")