Skip to content

Commit

Permalink
add issue link in fixme comments
Browse files Browse the repository at this point in the history
  • Loading branch information
QuietMisdreavus committed Dec 15, 2022
1 parent 59d2c7d commit 39731c2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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")
Expand Down

0 comments on commit 39731c2

Please sign in to comment.