Mark Expectation.onFailure as deprecated in favor of the require dsl

Quick · Dec 18, 2023 · d2bb507 · d2bb507
1 parent 40c06e9
commit d2bb507
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/Sources/Nimble/Expectation.swift b/Sources/Nimble/Expectation.swift
@@ -126,6 +126,12 @@ extension Expectation {
     ///            unconditionally log an error.
     ///
     /// - Remark: Similar functionality can be achieved using the `status` property.
+    /// - Attention: This is deprecated in favor of the `require` dsl (``require``, ``unwrap``,
+    ///              ``pollUnwrap``), which integrates the matcher seemlessly, or, in the case of
+    ///              `unwrap` and `pollUnwrap`, acts as a shorthand when you require that an
+    ///              expression evaluate to some non-nil value. `onFailure` will be removed in
+    ///              Nimble 15.
+    @available(*, deprecated, message: "Use the require dsl")
     public func onFailure(`throw` error: Error) throws {
         switch status {
         case .pending: