Deprecate an unused public render node transformer. (#1019)

Author: d-ronnqvist

Sources/SwiftDocC/Converter/Rewriter/RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation.swift

@@ -1,14 +1,15 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
 /// A transformation that removes automatically curated See Also sections.
+@available(*, deprecated, message: "This deprecated API will be removed after 6.1 is released")
 public struct RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation: RenderNodeTransforming {
     /// Creates a new transformer.
     public init() {}

Sources/SwiftDocC/SwiftDocC.docc/SwiftDocC/PersistingDocumentation.md

@@ -34,7 +34,6 @@ The precise path inside the output folder where resulting JSON file is saved is
 ### Render Node Rewriter
 
 - ``RenderNodeTransforming``
-- ``RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation``
 - ``RemoveUnusedReferencesTransformation``
 - ``RenderNodeTransformationComposition``
 - ``RenderNodeTransformationContext``

Tests/SwiftDocCTests/Converter/RenderNodeTransformerTests.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -12,6 +12,9 @@ import XCTest
 @testable import SwiftDocC
 
 class RenderNodeTransformerTests: XCTestCase {
+    // This test uses ``RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation`` which is deprecated.
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
+    @available(*, deprecated)
     func testRemovesAutomaticallyCuratedSeeAlsoSections() throws {
         let symbolJSON = try String(contentsOf: Bundle.module.url(
             forResource: "symbol-with-automatic-see-also-section", withExtension: "json",
@@ -28,6 +31,9 @@ class RenderNodeTransformerTests: XCTestCase {
         XCTAssertEqual(renderNode.references.count, 11)
     }
 
+    // This test uses ``RemoveAutomaticallyCuratedSeeAlsoSectionsTransformation`` which is deprecated.
+    // Deprecating the test silences the deprecation warning when running the tests. It doesn't skip the test.
+    @available(*, deprecated)
     func testRemovesAutomaticallyCuratedSeeAlsoSectionsPreservingReferences() throws {
         let symbolJSON = try String(contentsOf: Bundle.module.url(
             forResource: "symbol-auto-see-also-fragments-and-relationships", withExtension: "json",