Add comments to deprecated tests explaining that they aren't skipped

swiftlang · Oct 25, 2024 · 0d28c07 · 0d28c07
1 parent bc9a2b5
commit 0d28c07
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 0 deletions.
diff --git a/Tests/SwiftDocCTests/Converter/DocumentationConverterTests.swift b/Tests/SwiftDocCTests/Converter/DocumentationConverterTests.swift
@@ -12,6 +12,8 @@
 import XCTest
 @testable import SwiftDocC
 
+// This test verifies the behavior of `DocumentationConverter` which is a deprecated type.
+// Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
 @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
 class DocumentationConverterTests: XCTestCase {
     /// An empty implementation of `ConvertOutputConsumer` that purposefully does nothing.

diff --git a/Tests/SwiftDocCTests/Infrastructure/BundleDiscoveryTests.swift b/Tests/SwiftDocCTests/Infrastructure/BundleDiscoveryTests.swift
@@ -27,6 +27,7 @@ class BundleDiscoveryTests: XCTestCase {
     }
 
     // This tests registration of multiple catalogs which is deprecated
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
     @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
     func testFirstBundle() throws {
         let url = try createTemporaryDirectory()
@@ -63,6 +64,7 @@ class BundleDiscoveryTests: XCTestCase {
     }
 
     // This test registration more than once data provider which is deprecated.
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
     @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
     func testLoadComplexWorkspace() throws {
         let allFiles = try flatListOfFiles()

diff --git a/Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift b/Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
@@ -37,6 +37,7 @@ extension CollectionDifference {
 
 class DocumentationContextTests: XCTestCase {
     // This test checks unregistration of workspace data providers which is deprecated
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
     @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
     func testResolve() throws {
         let workspace = DocumentationWorkspace()
@@ -602,6 +603,7 @@ class DocumentationContextTests: XCTestCase {
     }
 
     // This test registration more than once data provider which is deprecated.
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
     @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
     func testCreatesCorrectIdentifiers() throws {
         let testBundleLocation = Bundle.module.url(

diff --git a/Tests/SwiftDocCTests/Infrastructure/DocumentationWorkspaceTests.swift b/Tests/SwiftDocCTests/Infrastructure/DocumentationWorkspaceTests.swift
@@ -11,6 +11,8 @@
 import XCTest
 @testable import SwiftDocC
 
+// This test verifies the behavior of `DocumentationWorkspace` which is a deprecated type.
+// Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
 @available(*, deprecated, message: "This deprecated API will be removed after 6.2 is released")
 class DocumentationWorkspaceTests: XCTestCase {
     func testEmptyWorkspace() {

diff --git a/Tests/SwiftDocCTests/Infrastructure/GeneratedDataProvider.swift b/Tests/SwiftDocCTests/Infrastructure/GeneratedDataProvider.swift
@@ -12,6 +12,8 @@ import XCTest
 @testable import SwiftDocC
 import SymbolKit
 
+// This test verifies the behavior of `GeneratedDataProvider` which is a deprecated type.
+// Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
 @available(*, deprecated, message: "Use 'DocumentationContext.InputProvider' instead. This deprecated API will be removed after 6.2 is released")
 class GeneratedDataProviderTests: XCTestCase {
 

diff --git a/Tests/SwiftDocCTests/Infrastructure/Input Discovery/DocumentationInputsProviderTests.swift b/Tests/SwiftDocCTests/Infrastructure/Input Discovery/DocumentationInputsProviderTests.swift
@@ -15,6 +15,7 @@ import SwiftDocCTestUtilities
 class DocumentationInputsProviderTests: XCTestCase {
 
     // After 6.2 we can update this test to verify that the input provider discovers the same inputs regardless of FileManagerProtocol
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
     @available(*, deprecated, message: "This test uses `LocalFileSystemDataProvider` as a `DocumentationWorkspaceDataProvider` which is deprecated and will be removed after 6.2 is released")
     func testDiscoversSameFilesAsPreviousImplementation() throws {
         let folderHierarchy = Folder(name: "one", content: [