You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, the documentation for `XCTestScaffold` has a "warning" callout to indicate that it is a temporary interface. This PR replaces the callout with a formal deprecation attribute so that the type and its members show as deprecated in our documentation. They are marked as deprecated in Swift 100000.0, which is a "magic" version number used in Apple's SDK to indicate "to-be-deprecated" status.
Copy file name to clipboardExpand all lines: Sources/Testing/Running/XCTestScaffold.swift
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -86,13 +86,14 @@ extension XCTIssue {
86
86
/// A type providing temporary tools for integrating the testing library and
87
87
/// the XCTest framework.
88
88
///
89
-
/// - Warning: This type is provided temporarily to aid in integrating the
90
-
/// testing library with existing tools such as Swift Package Manager. It
91
-
/// will be removed in a future release.
92
-
///
93
89
/// ## See Also
94
90
///
95
91
/// - <doc:TemporaryGettingStarted>
92
+
#if SWIFT_PM_SUPPORTS_SWIFT_TESTING
93
+
@available(*, deprecated, message:"This version of Swift Package Manager supports running swift-testing tests directly. This type will be removed in a future release.")
94
+
#else
95
+
@available(swift, deprecated:100000.0, message:"This type is provided temporarily to aid in integrating the testing library with existing tools such as Swift Package Manager. It will be removed in a future release.")
96
+
#endif
96
97
publicenumXCTestScaffold:Sendable{
97
98
/// Run all tests found in the current process and write output to the
98
99
/// standard error stream.
@@ -105,10 +106,6 @@ public enum XCTestScaffold: Sendable {
105
106
/// The format of the output is not meant to be machine-readable and is
106
107
/// subject to change.
107
108
///
108
-
/// - Warning: This function is provided temporarily to aid in integrating the
109
-
/// testing library with existing tools such as Swift Package Manager. It
110
-
/// will be removed in a future release.
111
-
///
112
109
/// ### Filtering tests
113
110
///
114
111
/// This function does not support the `--filter` argument passed to
@@ -167,7 +164,9 @@ public enum XCTestScaffold: Sendable {
167
164
///
168
165
/// - <doc:TemporaryGettingStarted>
169
166
#if SWIFT_PM_SUPPORTS_SWIFT_TESTING
170
-
@available(*, deprecated, message:"This version of Swift Package Manager supports running swift-testing tests directly. This function has no effect.")
167
+
@available(*, deprecated, message:"This version of Swift Package Manager supports running swift-testing tests directly. This function has no effect and will be removed in a future release.")
168
+
#else
169
+
@available(swift, deprecated:100000.0, message:"This function is provided temporarily to aid in integrating the testing library with existing tools such as Swift Package Manager. It will be removed in a future release.")
0 commit comments